Refresh all docs (#298)
Change the discovery query to fetch all discovery docs, not just the
preferred ones.
diff --git a/docs/dyn/adexchangebuyer_v1_2.accounts.html b/docs/dyn/adexchangebuyer_v1_2.accounts.html
new file mode 100644
index 0000000..de6a34b
--- /dev/null
+++ b/docs/dyn/adexchangebuyer_v1_2.accounts.html
@@ -0,0 +1,270 @@
+<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.
+ "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
+ "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
+ "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.
+ "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
+ "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
+ "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.
+ "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
+ "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
+ "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.
+ "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
+ "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
+ "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.
+ "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
+ "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
+ "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.
+ "maximumActiveCreatives": 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. 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.
+ "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/adexchangebuyer_v1_2.creatives.html b/docs/dyn/adexchangebuyer_v1_2.creatives.html
new file mode 100644
index 0000000..5d91dfa
--- /dev/null
+++ b/docs/dyn/adexchangebuyer_v1_2.creatives.html
@@ -0,0 +1,408 @@
+<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. A creative will be available 30-40 minutes after submission.</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. A creative will be available 30-40 minutes after submission.</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. A creative will be available 30-40 minutes after submission.
+
+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.
+ "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
+ "attribute": [ # All attributes for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "height": 42, # Ad height.
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
+ "A String",
+ ],
+ "accountId": 42, # Account id.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "width": 42, # Ad width.
+ "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
+ "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
+ "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,
+ ],
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "agencyId": "A String", # The agency id for this creative.
+ "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+ "A String",
+ ],
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
+ {
+ "reason": "A String", # The type of correction that was applied to the creative.
+ "details": [ # Additional details about the correction.
+ "A String",
+ ],
+ },
+ ],
+ "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
+ "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
+ "reasons": [ # The filtering reasons.
+ {
+ "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
+ "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
+ },
+ ],
+ },
+ }</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.
+ "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
+ "attribute": [ # All attributes for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "height": 42, # Ad height.
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
+ "A String",
+ ],
+ "accountId": 42, # Account id.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "width": 42, # Ad width.
+ "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
+ "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
+ "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,
+ ],
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "agencyId": "A String", # The agency id for this creative.
+ "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+ "A String",
+ ],
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
+ {
+ "reason": "A String", # The type of correction that was applied to the creative.
+ "details": [ # Additional details about the correction.
+ "A String",
+ ],
+ },
+ ],
+ "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
+ "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
+ "reasons": [ # The filtering reasons.
+ {
+ "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
+ "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
+ },
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A creative and its classification data.
+ "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
+ "attribute": [ # All attributes for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "height": 42, # Ad height.
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
+ "A String",
+ ],
+ "accountId": 42, # Account id.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "width": 42, # Ad width.
+ "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
+ "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
+ "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,
+ ],
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "agencyId": "A String", # The agency id for this creative.
+ "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+ "A String",
+ ],
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
+ {
+ "reason": "A String", # The type of correction that was applied to the creative.
+ "details": [ # Additional details about the correction.
+ "A String",
+ ],
+ },
+ ],
+ "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
+ "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
+ "reasons": [ # The filtering reasons.
+ {
+ "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
+ "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
+ },
+ ],
+ },
+ }</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. A creative will be available 30-40 minutes after submission.
+
+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.
+ "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
+ "attribute": [ # All attributes for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "height": 42, # Ad height.
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
+ "A String",
+ ],
+ "accountId": 42, # Account id.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "width": 42, # Ad width.
+ "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
+ "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
+ "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,
+ ],
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "agencyId": "A String", # The agency id for this creative.
+ "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+ "A String",
+ ],
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
+ {
+ "reason": "A String", # The type of correction that was applied to the creative.
+ "details": [ # Additional details about the correction.
+ "A String",
+ ],
+ },
+ ],
+ "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
+ "date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
+ "reasons": [ # The filtering reasons.
+ {
+ "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
+ "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
+ },
+ ],
+ },
+ },
+ ],
+ "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>
\ No newline at end of file
diff --git a/docs/dyn/manager_v1beta2.html b/docs/dyn/adexchangebuyer_v1_2.html
similarity index 85%
copy from docs/dyn/manager_v1beta2.html
copy to docs/dyn/adexchangebuyer_v1_2.html
index 44fc028..0c6d0bf 100644
--- a/docs/dyn/manager_v1beta2.html
+++ b/docs/dyn/adexchangebuyer_v1_2.html
@@ -72,17 +72,17 @@
</style>
-<h1><a href="manager_v1beta2.html">Deployment Manager API</a></h1>
+<h1><a href="adexchangebuyer_v1_2.html">Ad Exchange Buyer API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="manager_v1beta2.deployments.html">deployments()</a></code>
+ <code><a href="adexchangebuyer_v1_2.accounts.html">accounts()</a></code>
</p>
-<p class="firstline">Returns the deployments Resource.</p>
+<p class="firstline">Returns the accounts Resource.</p>
<p class="toc_element">
- <code><a href="manager_v1beta2.templates.html">templates()</a></code>
+ <code><a href="adexchangebuyer_v1_2.creatives.html">creatives()</a></code>
</p>
-<p class="firstline">Returns the templates Resource.</p>
+<p class="firstline">Returns the creatives Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/adexchangebuyer_v1_3.budget.html b/docs/dyn/adexchangebuyer_v1_3.budget.html
index e215f3f..2cfbbad 100644
--- a/docs/dyn/adexchangebuyer_v1_3.budget.html
+++ b/docs/dyn/adexchangebuyer_v1_3.budget.html
@@ -97,7 +97,7 @@
{ # The configuration data for Ad Exchange RTB - Budget API.
"kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
- "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests.
+ "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
"currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
"billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
"id": "A String", # The unique id that describes this item.
@@ -117,7 +117,7 @@
{ # The configuration data for Ad Exchange RTB - Budget API.
"kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
- "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests.
+ "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
"currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
"billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
"id": "A String", # The unique id that describes this item.
@@ -130,7 +130,7 @@
{ # The configuration data for Ad Exchange RTB - Budget API.
"kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
- "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests.
+ "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
"currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
"billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
"id": "A String", # The unique id that describes this item.
@@ -150,7 +150,7 @@
{ # The configuration data for Ad Exchange RTB - Budget API.
"kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
- "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests.
+ "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
"currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
"billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
"id": "A String", # The unique id that describes this item.
@@ -163,7 +163,7 @@
{ # The configuration data for Ad Exchange RTB - Budget API.
"kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
- "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests.
+ "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
"currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
"billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
"id": "A String", # The unique id that describes this item.
diff --git a/docs/dyn/adexchangebuyer_v1_3.creatives.html b/docs/dyn/adexchangebuyer_v1_3.creatives.html
index 4723382..348d2b9 100644
--- a/docs/dyn/adexchangebuyer_v1_3.creatives.html
+++ b/docs/dyn/adexchangebuyer_v1_3.creatives.html
@@ -99,32 +99,77 @@
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.
+ "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"attribute": [ # All attributes for the ads that may be shown from this snippet.
42,
],
- "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
- 42,
+ "height": 42, # Ad height.
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
+ "A String",
],
+ "accountId": 42, # Account id.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "width": 42, # Ad width.
+ "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
+ "body": "A String", # A long description of the ad.
+ "advertiser": "A String",
+ "store": "A String", # The URL to the app store to purchase/download the promoted app.
+ "headline": "A String", # A short title for the ad.
+ "image": { # A large image.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "logo": { # A smaller image, for the advertiser logo.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "appIcon": { # The app icon, for app download ads.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
+ "A String",
+ ],
+ "price": "A String", # The price of the promoted app including the currency info.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ },
+ "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
+ "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
42,
],
- "height": 42, # Ad height.
+ "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,
+ ],
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "agencyId": "A String", # The agency id for this creative.
"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",
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
+ 42,
],
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
{
@@ -143,18 +188,6 @@
},
],
},
- "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>
@@ -167,32 +200,77 @@
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.
+ "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"attribute": [ # All attributes for the ads that may be shown from this snippet.
42,
],
- "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
- 42,
+ "height": 42, # Ad height.
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
+ "A String",
],
+ "accountId": 42, # Account id.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "width": 42, # Ad width.
+ "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
+ "body": "A String", # A long description of the ad.
+ "advertiser": "A String",
+ "store": "A String", # The URL to the app store to purchase/download the promoted app.
+ "headline": "A String", # A short title for the ad.
+ "image": { # A large image.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "logo": { # A smaller image, for the advertiser logo.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "appIcon": { # The app icon, for app download ads.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
+ "A String",
+ ],
+ "price": "A String", # The price of the promoted app including the currency info.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ },
+ "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
+ "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
42,
],
- "height": 42, # Ad height.
+ "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,
+ ],
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "agencyId": "A String", # The agency id for this creative.
"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",
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
+ 42,
],
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
{
@@ -211,18 +289,6 @@
},
],
},
- "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.
}
@@ -230,32 +296,77 @@
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.
+ "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"attribute": [ # All attributes for the ads that may be shown from this snippet.
42,
],
- "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
- 42,
+ "height": 42, # Ad height.
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
+ "A String",
],
+ "accountId": 42, # Account id.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "width": 42, # Ad width.
+ "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
+ "body": "A String", # A long description of the ad.
+ "advertiser": "A String",
+ "store": "A String", # The URL to the app store to purchase/download the promoted app.
+ "headline": "A String", # A short title for the ad.
+ "image": { # A large image.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "logo": { # A smaller image, for the advertiser logo.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "appIcon": { # The app icon, for app download ads.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
+ "A String",
+ ],
+ "price": "A String", # The price of the promoted app including the currency info.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ },
+ "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
+ "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
42,
],
- "height": 42, # Ad height.
+ "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,
+ ],
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "agencyId": "A String", # The agency id for this creative.
"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",
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
+ 42,
],
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
{
@@ -274,18 +385,6 @@
},
],
},
- "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>
@@ -311,32 +410,77 @@
"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.
+ "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"attribute": [ # All attributes for the ads that may be shown from this snippet.
42,
],
- "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
- 42,
+ "height": 42, # Ad height.
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
+ "A String",
],
+ "accountId": 42, # Account id.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "width": 42, # Ad width.
+ "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
+ "body": "A String", # A long description of the ad.
+ "advertiser": "A String",
+ "store": "A String", # The URL to the app store to purchase/download the promoted app.
+ "headline": "A String", # A short title for the ad.
+ "image": { # A large image.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "logo": { # A smaller image, for the advertiser logo.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "appIcon": { # The app icon, for app download ads.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
+ "A String",
+ ],
+ "price": "A String", # The price of the promoted app including the currency info.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ },
+ "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
+ "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
42,
],
- "height": 42, # Ad height.
+ "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,
+ ],
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "agencyId": "A String", # The agency id for this creative.
"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",
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
+ 42,
],
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
{
@@ -355,18 +499,6 @@
},
],
},
- "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.
diff --git a/docs/dyn/adexchangebuyer_v1_3.directDeals.html b/docs/dyn/adexchangebuyer_v1_3.directDeals.html
index 0d4d0b9..c9dd025 100644
--- a/docs/dyn/adexchangebuyer_v1_3.directDeals.html
+++ b/docs/dyn/adexchangebuyer_v1_3.directDeals.html
@@ -94,13 +94,16 @@
{ # 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.
+ "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.
"name": "A String", # Deal name.
"currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
+ "allowsAlcohol": True or False, # Whether the publisher for this deal is eligible for alcohol ads.
+ "dealTier": "A String", # The deal type such as programmatic reservation or fixed price and so on.
"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).
"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).
"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.
"publisherBlocksOverriden": True or False, # If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal.
- "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.
+ "buyerAccountId": "A String", # The account id that this deal was negotiated for. It is either the buyer or the client that this deal was negotiated on behalf of.
"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.
@@ -122,13 +125,16 @@
{ # 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.
+ "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.
"name": "A String", # Deal name.
"currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
+ "allowsAlcohol": True or False, # Whether the publisher for this deal is eligible for alcohol ads.
+ "dealTier": "A String", # The deal type such as programmatic reservation or fixed price and so on.
"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).
"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).
"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.
"publisherBlocksOverriden": True or False, # If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal.
- "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.
+ "buyerAccountId": "A String", # The account id that this deal was negotiated for. It is either the buyer or the client that this deal was negotiated on behalf of.
"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.
diff --git a/docs/dyn/adexchangebuyer_v1_3.performanceReport.html b/docs/dyn/adexchangebuyer_v1_3.performanceReport.html
index 2764e41..c5759e8 100644
--- a/docs/dyn/adexchangebuyer_v1_3.performanceReport.html
+++ b/docs/dyn/adexchangebuyer_v1_3.performanceReport.html
@@ -92,7 +92,7 @@
Returns:
An object of the form:
- { # The configuration data for an Ad Exchange performance report list. 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
+ { # The configuration data for an Ad Exchange performance report list.
"kind": "adexchangebuyer#performanceReportList", # Resource type.
"performanceReport": [ # A list of performance reports relevant for the account.
{ # The configuration data for an Ad Exchange performance report list.
diff --git a/docs/dyn/adexchangebuyer_v1_4.clientaccess.html b/docs/dyn/adexchangebuyer_v1_4.clientaccess.html
deleted file mode 100644
index 6c737d8..0000000
--- a/docs/dyn/adexchangebuyer_v1_4.clientaccess.html
+++ /dev/null
@@ -1,233 +0,0 @@
-<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_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.clientaccess.html">clientaccess</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(clientAccountId, sponsorAccountId)</a></code></p>
-<p class="firstline">A description of how to use this function</p>
-<p class="toc_element">
- <code><a href="#get">get(clientAccountId, sponsorAccountId)</a></code></p>
-<p class="firstline">A description of how to use this function</p>
-<p class="toc_element">
- <code><a href="#insert">insert(body, clientAccountId=None, sponsorAccountId=None)</a></code></p>
-<p class="firstline">A description of how to use this function</p>
-<p class="toc_element">
- <code><a href="#list">list()</a></code></p>
-<p class="firstline">A description of how to use this function</p>
-<p class="toc_element">
- <code><a href="#patch">patch(clientAccountId, sponsorAccountId, body)</a></code></p>
-<p class="firstline">A description of how to use this function</p>
-<p class="toc_element">
- <code><a href="#update">update(clientAccountId, sponsorAccountId, 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="delete">delete(clientAccountId, sponsorAccountId)</code>
- <pre>A description of how to use this function
-
-Args:
- clientAccountId: string, A parameter (required)
- sponsorAccountId: integer, A parameter (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(clientAccountId, sponsorAccountId)</code>
- <pre>A description of how to use this function
-
-Args:
- clientAccountId: string, A parameter (required)
- sponsorAccountId: integer, A parameter (required)
-
-Returns:
- An object of the form:
-
- {
- "clientAccountId": "A String",
- "capabilities": [
- 42,
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(body, clientAccountId=None, sponsorAccountId=None)</code>
- <pre>A description of how to use this function
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "clientAccountId": "A String",
- "capabilities": [
- 42,
- ],
- }
-
- clientAccountId: string, A parameter
- sponsorAccountId: integer, A parameter
-
-Returns:
- An object of the form:
-
- {
- "clientAccountId": "A String",
- "capabilities": [
- 42,
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list()</code>
- <pre>A description of how to use this function
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "clientAccessPermissions": [
- {
- "clientAccountId": "A String",
- "capabilities": [
- 42,
- ],
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(clientAccountId, sponsorAccountId, body)</code>
- <pre>A description of how to use this function
-
-Args:
- clientAccountId: string, A parameter (required)
- sponsorAccountId: integer, A parameter (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "clientAccountId": "A String",
- "capabilities": [
- 42,
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "clientAccountId": "A String",
- "capabilities": [
- 42,
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(clientAccountId, sponsorAccountId, body)</code>
- <pre>A description of how to use this function
-
-Args:
- clientAccountId: string, A parameter (required)
- sponsorAccountId: integer, A parameter (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "clientAccountId": "A String",
- "capabilities": [
- 42,
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "clientAccountId": "A String",
- "capabilities": [
- 42,
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/adexchangebuyer_v1_4.deals.html b/docs/dyn/adexchangebuyer_v1_4.deals.html
deleted file mode 100644
index afb07e5..0000000
--- a/docs/dyn/adexchangebuyer_v1_4.deals.html
+++ /dev/null
@@ -1,423 +0,0 @@
-<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_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.deals.html">deals</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(dealId)</a></code></p>
-<p class="firstline">Gets the requested deal.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(dealId)</code>
- <pre>Gets the requested deal.
-
-Args:
- dealId: string, A parameter (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # The status of this negotiation.
- "buyerEmailContacts": [ # The buyer party's contact email.
- "A String",
- ],
- "labelNames": [ # A list of label names applicable to this negotiation.
- "A String",
- ],
- "billedBuyer": { # The billed buyer; Specified by a buyer buying through an intermediary.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "kind": "adexchangebuyer#negotiation",
- "offerId": "A String", # The ID of this negotiation's original offer.
- "negotiationRounds": [ # The series of negotiation rounds for this negotiation.
- {
- "kind": "adexchangebuyer#negotiationRound",
- "terms": { # The detailed terms proposed in this negotiation round.
- "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
- "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
- "positiveIcmInterests": [
- "A String",
- ],
- "positiveInventorySlots": [
- "A String",
- ],
- "negativeSiteUrls": [
- "A String",
- ],
- "positiveIcmBrands": [
- "A String",
- ],
- "negativeXfpPlacements": [
- "A String",
- ],
- "positiveVideoAdPositionSegments": [
- "A String",
- ],
- "negativeIcmInterests": [
- "A String",
- ],
- "negativeAudienceSegments": [
- "A String",
- ],
- "positiveOperatingSystems": [
- "A String",
- ],
- "negativeOperatingSystems": [
- "A String",
- ],
- "negativeIcmBrands": [
- "A String",
- ],
- "positiveLocations": [
- "A String",
- ],
- "negativeMobileApps": [
- "A String",
- ],
- "positiveDeviceCategories": [
- "A String",
- ],
- "negativeAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeInventorySlots": [
- "A String",
- ],
- "negativeVideoAdPositionSegments": [
- "A String",
- ],
- "negativeVideoDurationSegments": [
- "A String",
- ],
- "positiveSizes": [
- "A String",
- ],
- "positiveXfpAdSlots": [
- "A String",
- ],
- "positiveKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "positiveSiteUrls": [
- "A String",
- ],
- "positiveMobileApps": [
- "A String",
- ],
- "negativeKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "negativeSizes": [
- "A String",
- ],
- "positiveOperatingSystemVersions": [
- "A String",
- ],
- "negativeLocations": [
- "A String",
- ],
- "positiveAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeOperatingSystemVersions": [
- "A String",
- ],
- "positiveXfpPlacements": [
- "A String",
- ],
- "negativeXfpAdSlots": [
- "A String",
- ],
- "positiveVideoDurationSegments": [
- "A String",
- ],
- "positiveAudienceSegments": [
- "A String",
- ],
- "negativeDeviceCategories": [
- "A String",
- ],
- "positiveAdTypeSegments": [
- "A String",
- ],
- "negativeAdTypeSegments": [
- "A String",
- ],
- },
- "endDate": { # The end date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "termsAttributes": [ # A list of terms attributes.
- "A String",
- ],
- "startDate": { # The start date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "buyerBillingType": "A String", # The buyer billing type.
- "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
- "monetizerType": "A String", # The monetizer type.
- "targetByDealId": True or False, # Whether to target by deal id.
- "adSlots": [ # The particular ad slots targeted by the offer.
- {
- "name": "A String",
- "description": "A String",
- "channelId": 42,
- "channelCode": "A String",
- "webPropertyId": 42,
- "size": "A String",
- },
- ],
- "advertisers": [ # A list of advertisers for this offer.
- {
- "brands": [
- {
- "advertiserId": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "status": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "minimumSpendMicros": "A String", # The minimum spend for the offer.
- "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
- "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
- "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
- "dealPremium": { # The premium terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
- "audienceSegment": { # The audience segment for the offer.
- "numCookies": "A String",
- "description": "A String",
- "name": "A String",
- "id": "A String",
- },
- "description": "A String", # A description for these terms.
- "billingTerms": "A String", # The billing terms.
- "semiTransparent": True or False, # Whether this offer is semi-transparent.
- "minimumTrueLooks": "A String", # The minimum true looks for the offer.
- "cpm": { # The cpm terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "isReservation": True or False, # Whether the offer is a reservation.
- "descriptiveName": "A String", # A descriptive name for these terms.
- "urls": [ # The urls applicable to the offer.
- "A String",
- ],
- "estimatedSpend": { # The estimated spend for the offer.
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
- "roundNumber": "A String", # The number of this negotiation round, in sequence.
- "notes": "A String", # Notes regarding this negotiation round.
- "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
- "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
- "editHistory": { # The edit history of this negotiation round.
- "createdTimeStamp": "A String",
- "createdByLoginName": "A String",
- "lastUpdatedByLoginName": "A String",
- "lastUpdateTimeStamp": "A String",
- },
- "action": "A String", # The action performed by this negotiation round.
- },
- ],
- "negotiationId": "A String", # The unique ID of this negotiation.
- "negotiationState": "A String", # The state of this negotiation.
- "buyer": { # Details of the buyer party in this negotiation.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "stats": { # The stats for this negotiation.
- "revenue": {
- "micros": "A String",
- "currencyCode": "A String",
- },
- "bids": "A String",
- "impressions": "A String",
- "requests": "A String",
- "goodBids": "A String",
- "spend": {
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "externalDealId": "A String", # For finalized negotiations, the ID of the finalized deal.
- "seller": { # Details of the seller party in this negotiation.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "dealType": "A String", # The type of this deal.
- "sellerEmailContacts": [ # The seller party's contact email.
- "A String",
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/adexchangebuyer_v1_4.marketplaceoffers.html b/docs/dyn/adexchangebuyer_v1_4.marketplaceoffers.html
deleted file mode 100644
index 3963c03..0000000
--- a/docs/dyn/adexchangebuyer_v1_4.marketplaceoffers.html
+++ /dev/null
@@ -1,420 +0,0 @@
-<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_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.marketplaceoffers.html">marketplaceoffers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(offerId)</a></code></p>
-<p class="firstline">Gets the requested negotiation.</p>
-<p class="toc_element">
- <code><a href="#search">search(pqlQuery=None)</a></code></p>
-<p class="firstline">Gets the requested negotiation.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(offerId)</code>
- <pre>Gets the requested negotiation.
-
-Args:
- offerId: string, The offerId for the offer to get the head revision for. (required)
-
-Returns:
- An object of the form:
-
- { # An offer is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in an order can have one of the following setting:
- #
- # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
- "creatorContacts": [ # Optional contact information for the creator of this offer. (buyer-readonly)
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- "kind": "adexchangebuyer#marketplaceOffer", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOffer".
- "sharedTargetings": [ # Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)
- {
- "inclusions": [ # The list of value to include as part of the targeting.
- {
- "longValue": "A String", # The long value to exclude/include.
- "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
- "dayParts": [
- {
- "dayOfWeek": "A String",
- "endHour": 42,
- "startMinute": 42,
- "endMinute": 42,
- "startHour": 42,
- },
- ],
- "timeZoneType": "A String",
- },
- "creativeSizeValue": { # The creative size value to exclude/include.
- "creativeSizeType": "A String", # The Creative size type.
- "companionSizes": [ # For video size type, the list of companion sizes.
- {
- "width": 42, # The width of the creative.
- "height": 42, # The height of the creative.
- },
- ],
- "size": { # For regular creative size type, specifies the size of the creative.
- "width": 42, # The width of the creative.
- "height": 42, # The height of the creative.
- },
- },
- "stringValue": "A String", # The string value to exclude/include.
- },
- ],
- "exclusions": [ # The list of values to exclude from targeting.
- {
- "longValue": "A String", # The long value to exclude/include.
- "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
- "dayParts": [
- {
- "dayOfWeek": "A String",
- "endHour": 42,
- "startMinute": 42,
- "endMinute": 42,
- "startHour": 42,
- },
- ],
- "timeZoneType": "A String",
- },
- "creativeSizeValue": { # The creative size value to exclude/include.
- "creativeSizeType": "A String", # The Creative size type.
- "companionSizes": [ # For video size type, the list of companion sizes.
- {
- "width": 42, # The width of the creative.
- "height": 42, # The height of the creative.
- },
- ],
- "size": { # For regular creative size type, specifies the size of the creative.
- "width": 42, # The width of the creative.
- "height": 42, # The height of the creative.
- },
- },
- "stringValue": "A String", # The string value to exclude/include.
- },
- ],
- "key": "A String", # The key representing the shared targeting criterion.
- },
- ],
- "terms": { # The negotiable terms of the deal (buyer-readonly)
- "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
- "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The CPM value in micros.
- },
- },
- ],
- "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
- },
- "description": "A String", # Description for the proposed terms of the deal.
- "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
- "reservePricePerBuyers": [ # Reserve price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The CPM value in micros.
- },
- },
- ],
- "privateAuctionId": "A String", # Id of the corresponding private auction.
- },
- "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The CPM value in micros.
- },
- },
- ],
- },
- },
- "name": "A String", # The name for this offer as set by the seller. (buyer-readonly)
- "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
- "flightEndTimeMs": "A String", # The proposed end time for the deal (ms since epoch) (buyer-readonly)
- "labels": [ # Optional List of labels for the offer (optional, buyer-readonly).
- {
- "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
- "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
- "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
- "accountId": "A String", # Adx account id of the buyer.
- },
- "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- },
- "label": "A String", # The label to use.
- "accountId": "A String", # The accountId of the party that created the label.
- },
- ],
- "offerId": "A String", # The unique id for the offer (readonly)
- "seller": { # Information about the seller that created this offer (readonly, except on create)
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- "webPropertyCode": "A String",
- "state": "A String", # The state of the offer. (buyer-readonly)
- "hasCreatorSignedOff": True or False, # If the creator has already signed off on the offer, then the buyer can finalize the deal by accepting the offer as is. When copying to an order, if any of the terms are changed, then auto_finalize is automatically set to false.
- "flightStartTimeMs": "A String", # Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)
- "creationTimeMs": "A String", # Creation time in ms. since epoch (readonly)
- "lastUpdateTimeMs": "A String", # Time of last update in ms. since epoch (readonly)
- "revisionNumber": "A String", # The revision number of the offer. (readonly)
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="search">search(pqlQuery=None)</code>
- <pre>Gets the requested negotiation.
-
-Args:
- pqlQuery: string, The pql query used to query for offers.
-
-Returns:
- An object of the form:
-
- {
- "offers": [ # The returned list of offers.
- { # An offer is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in an order can have one of the following setting:
- #
- # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
- "creatorContacts": [ # Optional contact information for the creator of this offer. (buyer-readonly)
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- "kind": "adexchangebuyer#marketplaceOffer", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOffer".
- "sharedTargetings": [ # Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)
- {
- "inclusions": [ # The list of value to include as part of the targeting.
- {
- "longValue": "A String", # The long value to exclude/include.
- "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
- "dayParts": [
- {
- "dayOfWeek": "A String",
- "endHour": 42,
- "startMinute": 42,
- "endMinute": 42,
- "startHour": 42,
- },
- ],
- "timeZoneType": "A String",
- },
- "creativeSizeValue": { # The creative size value to exclude/include.
- "creativeSizeType": "A String", # The Creative size type.
- "companionSizes": [ # For video size type, the list of companion sizes.
- {
- "width": 42, # The width of the creative.
- "height": 42, # The height of the creative.
- },
- ],
- "size": { # For regular creative size type, specifies the size of the creative.
- "width": 42, # The width of the creative.
- "height": 42, # The height of the creative.
- },
- },
- "stringValue": "A String", # The string value to exclude/include.
- },
- ],
- "exclusions": [ # The list of values to exclude from targeting.
- {
- "longValue": "A String", # The long value to exclude/include.
- "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
- "dayParts": [
- {
- "dayOfWeek": "A String",
- "endHour": 42,
- "startMinute": 42,
- "endMinute": 42,
- "startHour": 42,
- },
- ],
- "timeZoneType": "A String",
- },
- "creativeSizeValue": { # The creative size value to exclude/include.
- "creativeSizeType": "A String", # The Creative size type.
- "companionSizes": [ # For video size type, the list of companion sizes.
- {
- "width": 42, # The width of the creative.
- "height": 42, # The height of the creative.
- },
- ],
- "size": { # For regular creative size type, specifies the size of the creative.
- "width": 42, # The width of the creative.
- "height": 42, # The height of the creative.
- },
- },
- "stringValue": "A String", # The string value to exclude/include.
- },
- ],
- "key": "A String", # The key representing the shared targeting criterion.
- },
- ],
- "terms": { # The negotiable terms of the deal (buyer-readonly)
- "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
- "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The CPM value in micros.
- },
- },
- ],
- "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
- },
- "description": "A String", # Description for the proposed terms of the deal.
- "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
- "reservePricePerBuyers": [ # Reserve price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The CPM value in micros.
- },
- },
- ],
- "privateAuctionId": "A String", # Id of the corresponding private auction.
- },
- "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The CPM value in micros.
- },
- },
- ],
- },
- },
- "name": "A String", # The name for this offer as set by the seller. (buyer-readonly)
- "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
- "flightEndTimeMs": "A String", # The proposed end time for the deal (ms since epoch) (buyer-readonly)
- "labels": [ # Optional List of labels for the offer (optional, buyer-readonly).
- {
- "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
- "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
- "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
- "accountId": "A String", # Adx account id of the buyer.
- },
- "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- },
- "label": "A String", # The label to use.
- "accountId": "A String", # The accountId of the party that created the label.
- },
- ],
- "offerId": "A String", # The unique id for the offer (readonly)
- "seller": { # Information about the seller that created this offer (readonly, except on create)
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- "webPropertyCode": "A String",
- "state": "A String", # The state of the offer. (buyer-readonly)
- "hasCreatorSignedOff": True or False, # If the creator has already signed off on the offer, then the buyer can finalize the deal by accepting the offer as is. When copying to an order, if any of the terms are changed, then auto_finalize is automatically set to false.
- "flightStartTimeMs": "A String", # Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)
- "creationTimeMs": "A String", # Creation time in ms. since epoch (readonly)
- "lastUpdateTimeMs": "A String", # Time of last update in ms. since epoch (readonly)
- "revisionNumber": "A String", # The revision number of the offer. (readonly)
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/adexchangebuyer_v1_4.marketplaceorders.html b/docs/dyn/adexchangebuyer_v1_4.marketplaceorders.html
deleted file mode 100644
index cabdc4f..0000000
--- a/docs/dyn/adexchangebuyer_v1_4.marketplaceorders.html
+++ /dev/null
@@ -1,665 +0,0 @@
-<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_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.marketplaceorders.html">marketplaceorders</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(orderId)</a></code></p>
-<p class="firstline">Get an order given its id</p>
-<p class="toc_element">
- <code><a href="#insert">insert(body)</a></code></p>
-<p class="firstline">Create the given list of orders</p>
-<p class="toc_element">
- <code><a href="#patch">patch(orderId, revisionNumber, updateAction, body)</a></code></p>
-<p class="firstline">Update the given order. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#search">search(pqlQuery=None)</a></code></p>
-<p class="firstline">Search for orders using pql query</p>
-<p class="toc_element">
- <code><a href="#update">update(orderId, revisionNumber, updateAction, body)</a></code></p>
-<p class="firstline">Update the given order</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(orderId)</code>
- <pre>Get an order given its id
-
-Args:
- orderId: string, Id of the order to retrieve. (required)
-
-Returns:
- An object of the form:
-
- { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
- #
- # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
- "orderId": "A String", # The unique id of the order. (readonly).
- "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
- "seller": { # Reference to the seller on the order. (readonly, except on create)
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- "name": "A String", # The name for the order (updatable)
- "buyerPrivateData": { # Private data for buyer. (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "labels": [ # List of labels associated with the order. (readonly)
- {
- "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
- "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
- "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
- "accountId": "A String", # Adx account id of the buyer.
- },
- "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- },
- "label": "A String", # The label to use.
- "accountId": "A String", # The accountId of the party that created the label.
- },
- ],
- "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
- "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
- "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- "lastUpdaterRole": "A String",
- "orderState": "A String", # The current state of the order. (readonly)
- "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
- "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
- "buyer": { # Reference to the buyer on the order. (readonly, except on create)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
- "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
- "revisionNumber": "A String", # The revision number for the order (readonly).
- "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
- "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(body)</code>
- <pre>Create the given list of orders
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "webPropertyCode": "A String",
- "orders": [ # The list of orders to create.
- { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
- #
- # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
- "orderId": "A String", # The unique id of the order. (readonly).
- "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
- "seller": { # Reference to the seller on the order. (readonly, except on create)
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- "name": "A String", # The name for the order (updatable)
- "buyerPrivateData": { # Private data for buyer. (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "labels": [ # List of labels associated with the order. (readonly)
- {
- "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
- "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
- "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
- "accountId": "A String", # Adx account id of the buyer.
- },
- "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- },
- "label": "A String", # The label to use.
- "accountId": "A String", # The accountId of the party that created the label.
- },
- ],
- "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
- "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
- "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- "lastUpdaterRole": "A String",
- "orderState": "A String", # The current state of the order. (readonly)
- "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
- "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
- "buyer": { # Reference to the buyer on the order. (readonly, except on create)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
- "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
- "revisionNumber": "A String", # The revision number for the order (readonly).
- "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
- "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "orders": [ # The list of orders successfully created.
- { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
- #
- # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
- "orderId": "A String", # The unique id of the order. (readonly).
- "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
- "seller": { # Reference to the seller on the order. (readonly, except on create)
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- "name": "A String", # The name for the order (updatable)
- "buyerPrivateData": { # Private data for buyer. (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "labels": [ # List of labels associated with the order. (readonly)
- {
- "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
- "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
- "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
- "accountId": "A String", # Adx account id of the buyer.
- },
- "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- },
- "label": "A String", # The label to use.
- "accountId": "A String", # The accountId of the party that created the label.
- },
- ],
- "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
- "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
- "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- "lastUpdaterRole": "A String",
- "orderState": "A String", # The current state of the order. (readonly)
- "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
- "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
- "buyer": { # Reference to the buyer on the order. (readonly, except on create)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
- "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
- "revisionNumber": "A String", # The revision number for the order (readonly).
- "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
- "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(orderId, revisionNumber, updateAction, body)</code>
- <pre>Update the given order. This method supports patch semantics.
-
-Args:
- orderId: string, The order id to update. (required)
- revisionNumber: string, The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the lastest order at head revision and retry the update at that revision. (required)
- updateAction: string, The proposed action to take on the order. (required)
- Allowed values
- accept -
- cancel -
- propose -
- unknownAction -
- updateFinalized -
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
- #
- # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
- "orderId": "A String", # The unique id of the order. (readonly).
- "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
- "seller": { # Reference to the seller on the order. (readonly, except on create)
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- "name": "A String", # The name for the order (updatable)
- "buyerPrivateData": { # Private data for buyer. (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "labels": [ # List of labels associated with the order. (readonly)
- {
- "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
- "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
- "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
- "accountId": "A String", # Adx account id of the buyer.
- },
- "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- },
- "label": "A String", # The label to use.
- "accountId": "A String", # The accountId of the party that created the label.
- },
- ],
- "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
- "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
- "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- "lastUpdaterRole": "A String",
- "orderState": "A String", # The current state of the order. (readonly)
- "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
- "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
- "buyer": { # Reference to the buyer on the order. (readonly, except on create)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
- "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
- "revisionNumber": "A String", # The revision number for the order (readonly).
- "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
- "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
-}
-
-
-Returns:
- An object of the form:
-
- { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
- #
- # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
- "orderId": "A String", # The unique id of the order. (readonly).
- "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
- "seller": { # Reference to the seller on the order. (readonly, except on create)
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- "name": "A String", # The name for the order (updatable)
- "buyerPrivateData": { # Private data for buyer. (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "labels": [ # List of labels associated with the order. (readonly)
- {
- "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
- "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
- "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
- "accountId": "A String", # Adx account id of the buyer.
- },
- "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- },
- "label": "A String", # The label to use.
- "accountId": "A String", # The accountId of the party that created the label.
- },
- ],
- "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
- "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
- "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- "lastUpdaterRole": "A String",
- "orderState": "A String", # The current state of the order. (readonly)
- "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
- "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
- "buyer": { # Reference to the buyer on the order. (readonly, except on create)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
- "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
- "revisionNumber": "A String", # The revision number for the order (readonly).
- "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
- "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="search">search(pqlQuery=None)</code>
- <pre>Search for orders using pql query
-
-Args:
- pqlQuery: string, Query string to retrieve specific orders.
-
-Returns:
- An object of the form:
-
- {
- "orders": [ # The list of matching orders.
- { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
- #
- # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
- "orderId": "A String", # The unique id of the order. (readonly).
- "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
- "seller": { # Reference to the seller on the order. (readonly, except on create)
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- "name": "A String", # The name for the order (updatable)
- "buyerPrivateData": { # Private data for buyer. (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "labels": [ # List of labels associated with the order. (readonly)
- {
- "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
- "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
- "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
- "accountId": "A String", # Adx account id of the buyer.
- },
- "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- },
- "label": "A String", # The label to use.
- "accountId": "A String", # The accountId of the party that created the label.
- },
- ],
- "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
- "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
- "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- "lastUpdaterRole": "A String",
- "orderState": "A String", # The current state of the order. (readonly)
- "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
- "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
- "buyer": { # Reference to the buyer on the order. (readonly, except on create)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
- "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
- "revisionNumber": "A String", # The revision number for the order (readonly).
- "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
- "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(orderId, revisionNumber, updateAction, body)</code>
- <pre>Update the given order
-
-Args:
- orderId: string, The order id to update. (required)
- revisionNumber: string, The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the lastest order at head revision and retry the update at that revision. (required)
- updateAction: string, The proposed action to take on the order. (required)
- Allowed values
- accept -
- cancel -
- propose -
- unknownAction -
- updateFinalized -
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
- #
- # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
- "orderId": "A String", # The unique id of the order. (readonly).
- "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
- "seller": { # Reference to the seller on the order. (readonly, except on create)
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- "name": "A String", # The name for the order (updatable)
- "buyerPrivateData": { # Private data for buyer. (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "labels": [ # List of labels associated with the order. (readonly)
- {
- "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
- "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
- "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
- "accountId": "A String", # Adx account id of the buyer.
- },
- "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- },
- "label": "A String", # The label to use.
- "accountId": "A String", # The accountId of the party that created the label.
- },
- ],
- "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
- "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
- "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- "lastUpdaterRole": "A String",
- "orderState": "A String", # The current state of the order. (readonly)
- "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
- "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
- "buyer": { # Reference to the buyer on the order. (readonly, except on create)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
- "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
- "revisionNumber": "A String", # The revision number for the order (readonly).
- "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
- "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
-}
-
-
-Returns:
- An object of the form:
-
- { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
- #
- # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
- "orderId": "A String", # The unique id of the order. (readonly).
- "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
- "seller": { # Reference to the seller on the order. (readonly, except on create)
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- "name": "A String", # The name for the order (updatable)
- "buyerPrivateData": { # Private data for buyer. (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "labels": [ # List of labels associated with the order. (readonly)
- {
- "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
- "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
- "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
- "accountId": "A String", # Adx account id of the buyer.
- },
- "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
- },
- },
- "label": "A String", # The label to use.
- "accountId": "A String", # The accountId of the party that created the label.
- },
- ],
- "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
- "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
- "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- "lastUpdaterRole": "A String",
- "orderState": "A String", # The current state of the order. (readonly)
- "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
- "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
- "buyer": { # Reference to the buyer on the order. (readonly, except on create)
- "accountId": "A String", # Adx account id of the buyer.
- },
- "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
- "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
- "revisionNumber": "A String", # The revision number for the order (readonly).
- "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
- "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/adexchangebuyer_v1_4.negotiationrounds.html b/docs/dyn/adexchangebuyer_v1_4.negotiationrounds.html
deleted file mode 100644
index 6739310..0000000
--- a/docs/dyn/adexchangebuyer_v1_4.negotiationrounds.html
+++ /dev/null
@@ -1,539 +0,0 @@
-<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_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.negotiationrounds.html">negotiationrounds</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#insert">insert(negotiationId, body)</a></code></p>
-<p class="firstline">Adds the requested negotiationRound to the requested negotiation.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="insert">insert(negotiationId, body)</code>
- <pre>Adds the requested negotiationRound to the requested negotiation.
-
-Args:
- negotiationId: string, A parameter (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "adexchangebuyer#negotiationRound",
- "terms": { # The detailed terms proposed in this negotiation round.
- "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
- "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
- "positiveIcmInterests": [
- "A String",
- ],
- "positiveInventorySlots": [
- "A String",
- ],
- "negativeSiteUrls": [
- "A String",
- ],
- "positiveIcmBrands": [
- "A String",
- ],
- "negativeXfpPlacements": [
- "A String",
- ],
- "positiveVideoAdPositionSegments": [
- "A String",
- ],
- "negativeIcmInterests": [
- "A String",
- ],
- "negativeAudienceSegments": [
- "A String",
- ],
- "positiveOperatingSystems": [
- "A String",
- ],
- "negativeOperatingSystems": [
- "A String",
- ],
- "negativeIcmBrands": [
- "A String",
- ],
- "positiveLocations": [
- "A String",
- ],
- "negativeMobileApps": [
- "A String",
- ],
- "positiveDeviceCategories": [
- "A String",
- ],
- "negativeAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeInventorySlots": [
- "A String",
- ],
- "negativeVideoAdPositionSegments": [
- "A String",
- ],
- "negativeVideoDurationSegments": [
- "A String",
- ],
- "positiveSizes": [
- "A String",
- ],
- "positiveXfpAdSlots": [
- "A String",
- ],
- "positiveKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "positiveSiteUrls": [
- "A String",
- ],
- "positiveMobileApps": [
- "A String",
- ],
- "negativeKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "negativeSizes": [
- "A String",
- ],
- "positiveOperatingSystemVersions": [
- "A String",
- ],
- "negativeLocations": [
- "A String",
- ],
- "positiveAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeOperatingSystemVersions": [
- "A String",
- ],
- "positiveXfpPlacements": [
- "A String",
- ],
- "negativeXfpAdSlots": [
- "A String",
- ],
- "positiveVideoDurationSegments": [
- "A String",
- ],
- "positiveAudienceSegments": [
- "A String",
- ],
- "negativeDeviceCategories": [
- "A String",
- ],
- "positiveAdTypeSegments": [
- "A String",
- ],
- "negativeAdTypeSegments": [
- "A String",
- ],
- },
- "endDate": { # The end date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "termsAttributes": [ # A list of terms attributes.
- "A String",
- ],
- "startDate": { # The start date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "buyerBillingType": "A String", # The buyer billing type.
- "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
- "monetizerType": "A String", # The monetizer type.
- "targetByDealId": True or False, # Whether to target by deal id.
- "adSlots": [ # The particular ad slots targeted by the offer.
- {
- "name": "A String",
- "description": "A String",
- "channelId": 42,
- "channelCode": "A String",
- "webPropertyId": 42,
- "size": "A String",
- },
- ],
- "advertisers": [ # A list of advertisers for this offer.
- {
- "brands": [
- {
- "advertiserId": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "status": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "minimumSpendMicros": "A String", # The minimum spend for the offer.
- "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
- "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
- "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
- "dealPremium": { # The premium terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
- "audienceSegment": { # The audience segment for the offer.
- "numCookies": "A String",
- "description": "A String",
- "name": "A String",
- "id": "A String",
- },
- "description": "A String", # A description for these terms.
- "billingTerms": "A String", # The billing terms.
- "semiTransparent": True or False, # Whether this offer is semi-transparent.
- "minimumTrueLooks": "A String", # The minimum true looks for the offer.
- "cpm": { # The cpm terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "isReservation": True or False, # Whether the offer is a reservation.
- "descriptiveName": "A String", # A descriptive name for these terms.
- "urls": [ # The urls applicable to the offer.
- "A String",
- ],
- "estimatedSpend": { # The estimated spend for the offer.
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
- "roundNumber": "A String", # The number of this negotiation round, in sequence.
- "notes": "A String", # Notes regarding this negotiation round.
- "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
- "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
- "editHistory": { # The edit history of this negotiation round.
- "createdTimeStamp": "A String",
- "createdByLoginName": "A String",
- "lastUpdatedByLoginName": "A String",
- "lastUpdateTimeStamp": "A String",
- },
- "action": "A String", # The action performed by this negotiation round.
-}
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "adexchangebuyer#negotiationRound",
- "terms": { # The detailed terms proposed in this negotiation round.
- "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
- "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
- "positiveIcmInterests": [
- "A String",
- ],
- "positiveInventorySlots": [
- "A String",
- ],
- "negativeSiteUrls": [
- "A String",
- ],
- "positiveIcmBrands": [
- "A String",
- ],
- "negativeXfpPlacements": [
- "A String",
- ],
- "positiveVideoAdPositionSegments": [
- "A String",
- ],
- "negativeIcmInterests": [
- "A String",
- ],
- "negativeAudienceSegments": [
- "A String",
- ],
- "positiveOperatingSystems": [
- "A String",
- ],
- "negativeOperatingSystems": [
- "A String",
- ],
- "negativeIcmBrands": [
- "A String",
- ],
- "positiveLocations": [
- "A String",
- ],
- "negativeMobileApps": [
- "A String",
- ],
- "positiveDeviceCategories": [
- "A String",
- ],
- "negativeAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeInventorySlots": [
- "A String",
- ],
- "negativeVideoAdPositionSegments": [
- "A String",
- ],
- "negativeVideoDurationSegments": [
- "A String",
- ],
- "positiveSizes": [
- "A String",
- ],
- "positiveXfpAdSlots": [
- "A String",
- ],
- "positiveKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "positiveSiteUrls": [
- "A String",
- ],
- "positiveMobileApps": [
- "A String",
- ],
- "negativeKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "negativeSizes": [
- "A String",
- ],
- "positiveOperatingSystemVersions": [
- "A String",
- ],
- "negativeLocations": [
- "A String",
- ],
- "positiveAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeOperatingSystemVersions": [
- "A String",
- ],
- "positiveXfpPlacements": [
- "A String",
- ],
- "negativeXfpAdSlots": [
- "A String",
- ],
- "positiveVideoDurationSegments": [
- "A String",
- ],
- "positiveAudienceSegments": [
- "A String",
- ],
- "negativeDeviceCategories": [
- "A String",
- ],
- "positiveAdTypeSegments": [
- "A String",
- ],
- "negativeAdTypeSegments": [
- "A String",
- ],
- },
- "endDate": { # The end date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "termsAttributes": [ # A list of terms attributes.
- "A String",
- ],
- "startDate": { # The start date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "buyerBillingType": "A String", # The buyer billing type.
- "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
- "monetizerType": "A String", # The monetizer type.
- "targetByDealId": True or False, # Whether to target by deal id.
- "adSlots": [ # The particular ad slots targeted by the offer.
- {
- "name": "A String",
- "description": "A String",
- "channelId": 42,
- "channelCode": "A String",
- "webPropertyId": 42,
- "size": "A String",
- },
- ],
- "advertisers": [ # A list of advertisers for this offer.
- {
- "brands": [
- {
- "advertiserId": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "status": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "minimumSpendMicros": "A String", # The minimum spend for the offer.
- "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
- "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
- "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
- "dealPremium": { # The premium terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
- "audienceSegment": { # The audience segment for the offer.
- "numCookies": "A String",
- "description": "A String",
- "name": "A String",
- "id": "A String",
- },
- "description": "A String", # A description for these terms.
- "billingTerms": "A String", # The billing terms.
- "semiTransparent": True or False, # Whether this offer is semi-transparent.
- "minimumTrueLooks": "A String", # The minimum true looks for the offer.
- "cpm": { # The cpm terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "isReservation": True or False, # Whether the offer is a reservation.
- "descriptiveName": "A String", # A descriptive name for these terms.
- "urls": [ # The urls applicable to the offer.
- "A String",
- ],
- "estimatedSpend": { # The estimated spend for the offer.
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
- "roundNumber": "A String", # The number of this negotiation round, in sequence.
- "notes": "A String", # Notes regarding this negotiation round.
- "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
- "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
- "editHistory": { # The edit history of this negotiation round.
- "createdTimeStamp": "A String",
- "createdByLoginName": "A String",
- "lastUpdatedByLoginName": "A String",
- "lastUpdateTimeStamp": "A String",
- },
- "action": "A String", # The action performed by this negotiation round.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/adexchangebuyer_v1_4.negotiations.html b/docs/dyn/adexchangebuyer_v1_4.negotiations.html
deleted file mode 100644
index afebd4e..0000000
--- a/docs/dyn/adexchangebuyer_v1_4.negotiations.html
+++ /dev/null
@@ -1,1450 +0,0 @@
-<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_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.negotiations.html">negotiations</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(negotiationId)</a></code></p>
-<p class="firstline">Gets the requested negotiation.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(body)</a></code></p>
-<p class="firstline">Creates or updates the requested negotiation.</p>
-<p class="toc_element">
- <code><a href="#list">list()</a></code></p>
-<p class="firstline">Lists all negotiations the authenticated user has access to.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(negotiationId)</code>
- <pre>Gets the requested negotiation.
-
-Args:
- negotiationId: string, A parameter (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # The status of this negotiation.
- "buyerEmailContacts": [ # The buyer party's contact email.
- "A String",
- ],
- "labelNames": [ # A list of label names applicable to this negotiation.
- "A String",
- ],
- "billedBuyer": { # The billed buyer; Specified by a buyer buying through an intermediary.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "kind": "adexchangebuyer#negotiation",
- "offerId": "A String", # The ID of this negotiation's original offer.
- "negotiationRounds": [ # The series of negotiation rounds for this negotiation.
- {
- "kind": "adexchangebuyer#negotiationRound",
- "terms": { # The detailed terms proposed in this negotiation round.
- "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
- "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
- "positiveIcmInterests": [
- "A String",
- ],
- "positiveInventorySlots": [
- "A String",
- ],
- "negativeSiteUrls": [
- "A String",
- ],
- "positiveIcmBrands": [
- "A String",
- ],
- "negativeXfpPlacements": [
- "A String",
- ],
- "positiveVideoAdPositionSegments": [
- "A String",
- ],
- "negativeIcmInterests": [
- "A String",
- ],
- "negativeAudienceSegments": [
- "A String",
- ],
- "positiveOperatingSystems": [
- "A String",
- ],
- "negativeOperatingSystems": [
- "A String",
- ],
- "negativeIcmBrands": [
- "A String",
- ],
- "positiveLocations": [
- "A String",
- ],
- "negativeMobileApps": [
- "A String",
- ],
- "positiveDeviceCategories": [
- "A String",
- ],
- "negativeAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeInventorySlots": [
- "A String",
- ],
- "negativeVideoAdPositionSegments": [
- "A String",
- ],
- "negativeVideoDurationSegments": [
- "A String",
- ],
- "positiveSizes": [
- "A String",
- ],
- "positiveXfpAdSlots": [
- "A String",
- ],
- "positiveKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "positiveSiteUrls": [
- "A String",
- ],
- "positiveMobileApps": [
- "A String",
- ],
- "negativeKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "negativeSizes": [
- "A String",
- ],
- "positiveOperatingSystemVersions": [
- "A String",
- ],
- "negativeLocations": [
- "A String",
- ],
- "positiveAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeOperatingSystemVersions": [
- "A String",
- ],
- "positiveXfpPlacements": [
- "A String",
- ],
- "negativeXfpAdSlots": [
- "A String",
- ],
- "positiveVideoDurationSegments": [
- "A String",
- ],
- "positiveAudienceSegments": [
- "A String",
- ],
- "negativeDeviceCategories": [
- "A String",
- ],
- "positiveAdTypeSegments": [
- "A String",
- ],
- "negativeAdTypeSegments": [
- "A String",
- ],
- },
- "endDate": { # The end date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "termsAttributes": [ # A list of terms attributes.
- "A String",
- ],
- "startDate": { # The start date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "buyerBillingType": "A String", # The buyer billing type.
- "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
- "monetizerType": "A String", # The monetizer type.
- "targetByDealId": True or False, # Whether to target by deal id.
- "adSlots": [ # The particular ad slots targeted by the offer.
- {
- "name": "A String",
- "description": "A String",
- "channelId": 42,
- "channelCode": "A String",
- "webPropertyId": 42,
- "size": "A String",
- },
- ],
- "advertisers": [ # A list of advertisers for this offer.
- {
- "brands": [
- {
- "advertiserId": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "status": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "minimumSpendMicros": "A String", # The minimum spend for the offer.
- "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
- "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
- "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
- "dealPremium": { # The premium terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
- "audienceSegment": { # The audience segment for the offer.
- "numCookies": "A String",
- "description": "A String",
- "name": "A String",
- "id": "A String",
- },
- "description": "A String", # A description for these terms.
- "billingTerms": "A String", # The billing terms.
- "semiTransparent": True or False, # Whether this offer is semi-transparent.
- "minimumTrueLooks": "A String", # The minimum true looks for the offer.
- "cpm": { # The cpm terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "isReservation": True or False, # Whether the offer is a reservation.
- "descriptiveName": "A String", # A descriptive name for these terms.
- "urls": [ # The urls applicable to the offer.
- "A String",
- ],
- "estimatedSpend": { # The estimated spend for the offer.
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
- "roundNumber": "A String", # The number of this negotiation round, in sequence.
- "notes": "A String", # Notes regarding this negotiation round.
- "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
- "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
- "editHistory": { # The edit history of this negotiation round.
- "createdTimeStamp": "A String",
- "createdByLoginName": "A String",
- "lastUpdatedByLoginName": "A String",
- "lastUpdateTimeStamp": "A String",
- },
- "action": "A String", # The action performed by this negotiation round.
- },
- ],
- "negotiationId": "A String", # The unique ID of this negotiation.
- "negotiationState": "A String", # The state of this negotiation.
- "buyer": { # Details of the buyer party in this negotiation.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "stats": { # The stats for this negotiation.
- "revenue": {
- "micros": "A String",
- "currencyCode": "A String",
- },
- "bids": "A String",
- "impressions": "A String",
- "requests": "A String",
- "goodBids": "A String",
- "spend": {
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "externalDealId": "A String", # For finalized negotiations, the ID of the finalized deal.
- "seller": { # Details of the seller party in this negotiation.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "dealType": "A String", # The type of this deal.
- "sellerEmailContacts": [ # The seller party's contact email.
- "A String",
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(body)</code>
- <pre>Creates or updates the requested negotiation.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # The status of this negotiation.
- "buyerEmailContacts": [ # The buyer party's contact email.
- "A String",
- ],
- "labelNames": [ # A list of label names applicable to this negotiation.
- "A String",
- ],
- "billedBuyer": { # The billed buyer; Specified by a buyer buying through an intermediary.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "kind": "adexchangebuyer#negotiation",
- "offerId": "A String", # The ID of this negotiation's original offer.
- "negotiationRounds": [ # The series of negotiation rounds for this negotiation.
- {
- "kind": "adexchangebuyer#negotiationRound",
- "terms": { # The detailed terms proposed in this negotiation round.
- "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
- "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
- "positiveIcmInterests": [
- "A String",
- ],
- "positiveInventorySlots": [
- "A String",
- ],
- "negativeSiteUrls": [
- "A String",
- ],
- "positiveIcmBrands": [
- "A String",
- ],
- "negativeXfpPlacements": [
- "A String",
- ],
- "positiveVideoAdPositionSegments": [
- "A String",
- ],
- "negativeIcmInterests": [
- "A String",
- ],
- "negativeAudienceSegments": [
- "A String",
- ],
- "positiveOperatingSystems": [
- "A String",
- ],
- "negativeOperatingSystems": [
- "A String",
- ],
- "negativeIcmBrands": [
- "A String",
- ],
- "positiveLocations": [
- "A String",
- ],
- "negativeMobileApps": [
- "A String",
- ],
- "positiveDeviceCategories": [
- "A String",
- ],
- "negativeAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeInventorySlots": [
- "A String",
- ],
- "negativeVideoAdPositionSegments": [
- "A String",
- ],
- "negativeVideoDurationSegments": [
- "A String",
- ],
- "positiveSizes": [
- "A String",
- ],
- "positiveXfpAdSlots": [
- "A String",
- ],
- "positiveKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "positiveSiteUrls": [
- "A String",
- ],
- "positiveMobileApps": [
- "A String",
- ],
- "negativeKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "negativeSizes": [
- "A String",
- ],
- "positiveOperatingSystemVersions": [
- "A String",
- ],
- "negativeLocations": [
- "A String",
- ],
- "positiveAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeOperatingSystemVersions": [
- "A String",
- ],
- "positiveXfpPlacements": [
- "A String",
- ],
- "negativeXfpAdSlots": [
- "A String",
- ],
- "positiveVideoDurationSegments": [
- "A String",
- ],
- "positiveAudienceSegments": [
- "A String",
- ],
- "negativeDeviceCategories": [
- "A String",
- ],
- "positiveAdTypeSegments": [
- "A String",
- ],
- "negativeAdTypeSegments": [
- "A String",
- ],
- },
- "endDate": { # The end date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "termsAttributes": [ # A list of terms attributes.
- "A String",
- ],
- "startDate": { # The start date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "buyerBillingType": "A String", # The buyer billing type.
- "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
- "monetizerType": "A String", # The monetizer type.
- "targetByDealId": True or False, # Whether to target by deal id.
- "adSlots": [ # The particular ad slots targeted by the offer.
- {
- "name": "A String",
- "description": "A String",
- "channelId": 42,
- "channelCode": "A String",
- "webPropertyId": 42,
- "size": "A String",
- },
- ],
- "advertisers": [ # A list of advertisers for this offer.
- {
- "brands": [
- {
- "advertiserId": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "status": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "minimumSpendMicros": "A String", # The minimum spend for the offer.
- "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
- "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
- "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
- "dealPremium": { # The premium terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
- "audienceSegment": { # The audience segment for the offer.
- "numCookies": "A String",
- "description": "A String",
- "name": "A String",
- "id": "A String",
- },
- "description": "A String", # A description for these terms.
- "billingTerms": "A String", # The billing terms.
- "semiTransparent": True or False, # Whether this offer is semi-transparent.
- "minimumTrueLooks": "A String", # The minimum true looks for the offer.
- "cpm": { # The cpm terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "isReservation": True or False, # Whether the offer is a reservation.
- "descriptiveName": "A String", # A descriptive name for these terms.
- "urls": [ # The urls applicable to the offer.
- "A String",
- ],
- "estimatedSpend": { # The estimated spend for the offer.
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
- "roundNumber": "A String", # The number of this negotiation round, in sequence.
- "notes": "A String", # Notes regarding this negotiation round.
- "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
- "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
- "editHistory": { # The edit history of this negotiation round.
- "createdTimeStamp": "A String",
- "createdByLoginName": "A String",
- "lastUpdatedByLoginName": "A String",
- "lastUpdateTimeStamp": "A String",
- },
- "action": "A String", # The action performed by this negotiation round.
- },
- ],
- "negotiationId": "A String", # The unique ID of this negotiation.
- "negotiationState": "A String", # The state of this negotiation.
- "buyer": { # Details of the buyer party in this negotiation.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "stats": { # The stats for this negotiation.
- "revenue": {
- "micros": "A String",
- "currencyCode": "A String",
- },
- "bids": "A String",
- "impressions": "A String",
- "requests": "A String",
- "goodBids": "A String",
- "spend": {
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "externalDealId": "A String", # For finalized negotiations, the ID of the finalized deal.
- "seller": { # Details of the seller party in this negotiation.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "dealType": "A String", # The type of this deal.
- "sellerEmailContacts": [ # The seller party's contact email.
- "A String",
- ],
-}
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # The status of this negotiation.
- "buyerEmailContacts": [ # The buyer party's contact email.
- "A String",
- ],
- "labelNames": [ # A list of label names applicable to this negotiation.
- "A String",
- ],
- "billedBuyer": { # The billed buyer; Specified by a buyer buying through an intermediary.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "kind": "adexchangebuyer#negotiation",
- "offerId": "A String", # The ID of this negotiation's original offer.
- "negotiationRounds": [ # The series of negotiation rounds for this negotiation.
- {
- "kind": "adexchangebuyer#negotiationRound",
- "terms": { # The detailed terms proposed in this negotiation round.
- "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
- "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
- "positiveIcmInterests": [
- "A String",
- ],
- "positiveInventorySlots": [
- "A String",
- ],
- "negativeSiteUrls": [
- "A String",
- ],
- "positiveIcmBrands": [
- "A String",
- ],
- "negativeXfpPlacements": [
- "A String",
- ],
- "positiveVideoAdPositionSegments": [
- "A String",
- ],
- "negativeIcmInterests": [
- "A String",
- ],
- "negativeAudienceSegments": [
- "A String",
- ],
- "positiveOperatingSystems": [
- "A String",
- ],
- "negativeOperatingSystems": [
- "A String",
- ],
- "negativeIcmBrands": [
- "A String",
- ],
- "positiveLocations": [
- "A String",
- ],
- "negativeMobileApps": [
- "A String",
- ],
- "positiveDeviceCategories": [
- "A String",
- ],
- "negativeAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeInventorySlots": [
- "A String",
- ],
- "negativeVideoAdPositionSegments": [
- "A String",
- ],
- "negativeVideoDurationSegments": [
- "A String",
- ],
- "positiveSizes": [
- "A String",
- ],
- "positiveXfpAdSlots": [
- "A String",
- ],
- "positiveKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "positiveSiteUrls": [
- "A String",
- ],
- "positiveMobileApps": [
- "A String",
- ],
- "negativeKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "negativeSizes": [
- "A String",
- ],
- "positiveOperatingSystemVersions": [
- "A String",
- ],
- "negativeLocations": [
- "A String",
- ],
- "positiveAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeOperatingSystemVersions": [
- "A String",
- ],
- "positiveXfpPlacements": [
- "A String",
- ],
- "negativeXfpAdSlots": [
- "A String",
- ],
- "positiveVideoDurationSegments": [
- "A String",
- ],
- "positiveAudienceSegments": [
- "A String",
- ],
- "negativeDeviceCategories": [
- "A String",
- ],
- "positiveAdTypeSegments": [
- "A String",
- ],
- "negativeAdTypeSegments": [
- "A String",
- ],
- },
- "endDate": { # The end date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "termsAttributes": [ # A list of terms attributes.
- "A String",
- ],
- "startDate": { # The start date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "buyerBillingType": "A String", # The buyer billing type.
- "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
- "monetizerType": "A String", # The monetizer type.
- "targetByDealId": True or False, # Whether to target by deal id.
- "adSlots": [ # The particular ad slots targeted by the offer.
- {
- "name": "A String",
- "description": "A String",
- "channelId": 42,
- "channelCode": "A String",
- "webPropertyId": 42,
- "size": "A String",
- },
- ],
- "advertisers": [ # A list of advertisers for this offer.
- {
- "brands": [
- {
- "advertiserId": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "status": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "minimumSpendMicros": "A String", # The minimum spend for the offer.
- "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
- "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
- "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
- "dealPremium": { # The premium terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
- "audienceSegment": { # The audience segment for the offer.
- "numCookies": "A String",
- "description": "A String",
- "name": "A String",
- "id": "A String",
- },
- "description": "A String", # A description for these terms.
- "billingTerms": "A String", # The billing terms.
- "semiTransparent": True or False, # Whether this offer is semi-transparent.
- "minimumTrueLooks": "A String", # The minimum true looks for the offer.
- "cpm": { # The cpm terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "isReservation": True or False, # Whether the offer is a reservation.
- "descriptiveName": "A String", # A descriptive name for these terms.
- "urls": [ # The urls applicable to the offer.
- "A String",
- ],
- "estimatedSpend": { # The estimated spend for the offer.
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
- "roundNumber": "A String", # The number of this negotiation round, in sequence.
- "notes": "A String", # Notes regarding this negotiation round.
- "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
- "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
- "editHistory": { # The edit history of this negotiation round.
- "createdTimeStamp": "A String",
- "createdByLoginName": "A String",
- "lastUpdatedByLoginName": "A String",
- "lastUpdateTimeStamp": "A String",
- },
- "action": "A String", # The action performed by this negotiation round.
- },
- ],
- "negotiationId": "A String", # The unique ID of this negotiation.
- "negotiationState": "A String", # The state of this negotiation.
- "buyer": { # Details of the buyer party in this negotiation.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "stats": { # The stats for this negotiation.
- "revenue": {
- "micros": "A String",
- "currencyCode": "A String",
- },
- "bids": "A String",
- "impressions": "A String",
- "requests": "A String",
- "goodBids": "A String",
- "spend": {
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "externalDealId": "A String", # For finalized negotiations, the ID of the finalized deal.
- "seller": { # Details of the seller party in this negotiation.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "dealType": "A String", # The type of this deal.
- "sellerEmailContacts": [ # The seller party's contact email.
- "A String",
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list()</code>
- <pre>Lists all negotiations the authenticated user has access to.
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "kind": "adexchangebuyer#negotiationsList",
- "negotiations": [
- {
- "status": "A String", # The status of this negotiation.
- "buyerEmailContacts": [ # The buyer party's contact email.
- "A String",
- ],
- "labelNames": [ # A list of label names applicable to this negotiation.
- "A String",
- ],
- "billedBuyer": { # The billed buyer; Specified by a buyer buying through an intermediary.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "kind": "adexchangebuyer#negotiation",
- "offerId": "A String", # The ID of this negotiation's original offer.
- "negotiationRounds": [ # The series of negotiation rounds for this negotiation.
- {
- "kind": "adexchangebuyer#negotiationRound",
- "terms": { # The detailed terms proposed in this negotiation round.
- "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
- "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
- "positiveIcmInterests": [
- "A String",
- ],
- "positiveInventorySlots": [
- "A String",
- ],
- "negativeSiteUrls": [
- "A String",
- ],
- "positiveIcmBrands": [
- "A String",
- ],
- "negativeXfpPlacements": [
- "A String",
- ],
- "positiveVideoAdPositionSegments": [
- "A String",
- ],
- "negativeIcmInterests": [
- "A String",
- ],
- "negativeAudienceSegments": [
- "A String",
- ],
- "positiveOperatingSystems": [
- "A String",
- ],
- "negativeOperatingSystems": [
- "A String",
- ],
- "negativeIcmBrands": [
- "A String",
- ],
- "positiveLocations": [
- "A String",
- ],
- "negativeMobileApps": [
- "A String",
- ],
- "positiveDeviceCategories": [
- "A String",
- ],
- "negativeAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeInventorySlots": [
- "A String",
- ],
- "negativeVideoAdPositionSegments": [
- "A String",
- ],
- "negativeVideoDurationSegments": [
- "A String",
- ],
- "positiveSizes": [
- "A String",
- ],
- "positiveXfpAdSlots": [
- "A String",
- ],
- "positiveKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "positiveSiteUrls": [
- "A String",
- ],
- "positiveMobileApps": [
- "A String",
- ],
- "negativeKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "negativeSizes": [
- "A String",
- ],
- "positiveOperatingSystemVersions": [
- "A String",
- ],
- "negativeLocations": [
- "A String",
- ],
- "positiveAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeOperatingSystemVersions": [
- "A String",
- ],
- "positiveXfpPlacements": [
- "A String",
- ],
- "negativeXfpAdSlots": [
- "A String",
- ],
- "positiveVideoDurationSegments": [
- "A String",
- ],
- "positiveAudienceSegments": [
- "A String",
- ],
- "negativeDeviceCategories": [
- "A String",
- ],
- "positiveAdTypeSegments": [
- "A String",
- ],
- "negativeAdTypeSegments": [
- "A String",
- ],
- },
- "endDate": { # The end date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "termsAttributes": [ # A list of terms attributes.
- "A String",
- ],
- "startDate": { # The start date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "buyerBillingType": "A String", # The buyer billing type.
- "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
- "monetizerType": "A String", # The monetizer type.
- "targetByDealId": True or False, # Whether to target by deal id.
- "adSlots": [ # The particular ad slots targeted by the offer.
- {
- "name": "A String",
- "description": "A String",
- "channelId": 42,
- "channelCode": "A String",
- "webPropertyId": 42,
- "size": "A String",
- },
- ],
- "advertisers": [ # A list of advertisers for this offer.
- {
- "brands": [
- {
- "advertiserId": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "status": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "minimumSpendMicros": "A String", # The minimum spend for the offer.
- "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
- "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
- "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
- "dealPremium": { # The premium terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
- "audienceSegment": { # The audience segment for the offer.
- "numCookies": "A String",
- "description": "A String",
- "name": "A String",
- "id": "A String",
- },
- "description": "A String", # A description for these terms.
- "billingTerms": "A String", # The billing terms.
- "semiTransparent": True or False, # Whether this offer is semi-transparent.
- "minimumTrueLooks": "A String", # The minimum true looks for the offer.
- "cpm": { # The cpm terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "isReservation": True or False, # Whether the offer is a reservation.
- "descriptiveName": "A String", # A descriptive name for these terms.
- "urls": [ # The urls applicable to the offer.
- "A String",
- ],
- "estimatedSpend": { # The estimated spend for the offer.
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
- "roundNumber": "A String", # The number of this negotiation round, in sequence.
- "notes": "A String", # Notes regarding this negotiation round.
- "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
- "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
- "editHistory": { # The edit history of this negotiation round.
- "createdTimeStamp": "A String",
- "createdByLoginName": "A String",
- "lastUpdatedByLoginName": "A String",
- "lastUpdateTimeStamp": "A String",
- },
- "action": "A String", # The action performed by this negotiation round.
- },
- ],
- "negotiationId": "A String", # The unique ID of this negotiation.
- "negotiationState": "A String", # The state of this negotiation.
- "buyer": { # Details of the buyer party in this negotiation.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "stats": { # The stats for this negotiation.
- "revenue": {
- "micros": "A String",
- "currencyCode": "A String",
- },
- "bids": "A String",
- "impressions": "A String",
- "requests": "A String",
- "goodBids": "A String",
- "spend": {
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "externalDealId": "A String", # For finalized negotiations, the ID of the finalized deal.
- "seller": { # Details of the seller party in this negotiation.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "dealType": "A String", # The type of this deal.
- "sellerEmailContacts": [ # The seller party's contact email.
- "A String",
- ],
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/adexchangebuyer_v1_4.offers.html b/docs/dyn/adexchangebuyer_v1_4.offers.html
deleted file mode 100644
index 0d9e056..0000000
--- a/docs/dyn/adexchangebuyer_v1_4.offers.html
+++ /dev/null
@@ -1,1430 +0,0 @@
-<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_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.offers.html">offers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(offerId)</a></code></p>
-<p class="firstline">Gets the requested offer.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(body)</a></code></p>
-<p class="firstline">Creates or updates the requested offer.</p>
-<p class="toc_element">
- <code><a href="#list">list()</a></code></p>
-<p class="firstline">Lists all offers the authenticated user has access to.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(offerId)</code>
- <pre>Gets the requested offer.
-
-Args:
- offerId: string, A parameter (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # The status of this offer.
- "kind": "adexchangebuyer#offer",
- "labelNames": [ # The list of label names applicable to this offer.
- "A String",
- ],
- "pointOfContact": "A String", # The point of contact for this offer.
- "isOpen": True or False, # Whether this offer is open.
- "creator": { # The creator of this offer.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "closedToDealParties": [ # The list of buyer or seller parties this offer is closed to.
- {
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- ],
- "billedBuyer": { # The billed buyer; For buyer initiated offers, buying through an intermediary.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "offerId": "A String", # The unique ID of this offer.
- "openToDealParties": [ # The list of buyer or seller parties this offer is open to.
- {
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- ],
- "offerState": "A String", # The state of this offer.
- "anonymous": True or False, # Whether this offer is anonymous.
- "terms": { # The terms of this offer.
- "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
- "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
- "positiveIcmInterests": [
- "A String",
- ],
- "positiveInventorySlots": [
- "A String",
- ],
- "negativeSiteUrls": [
- "A String",
- ],
- "positiveIcmBrands": [
- "A String",
- ],
- "negativeXfpPlacements": [
- "A String",
- ],
- "positiveVideoAdPositionSegments": [
- "A String",
- ],
- "negativeIcmInterests": [
- "A String",
- ],
- "negativeAudienceSegments": [
- "A String",
- ],
- "positiveOperatingSystems": [
- "A String",
- ],
- "negativeOperatingSystems": [
- "A String",
- ],
- "negativeIcmBrands": [
- "A String",
- ],
- "positiveLocations": [
- "A String",
- ],
- "negativeMobileApps": [
- "A String",
- ],
- "positiveDeviceCategories": [
- "A String",
- ],
- "negativeAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeInventorySlots": [
- "A String",
- ],
- "negativeVideoAdPositionSegments": [
- "A String",
- ],
- "negativeVideoDurationSegments": [
- "A String",
- ],
- "positiveSizes": [
- "A String",
- ],
- "positiveXfpAdSlots": [
- "A String",
- ],
- "positiveKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "positiveSiteUrls": [
- "A String",
- ],
- "positiveMobileApps": [
- "A String",
- ],
- "negativeKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "negativeSizes": [
- "A String",
- ],
- "positiveOperatingSystemVersions": [
- "A String",
- ],
- "negativeLocations": [
- "A String",
- ],
- "positiveAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeOperatingSystemVersions": [
- "A String",
- ],
- "positiveXfpPlacements": [
- "A String",
- ],
- "negativeXfpAdSlots": [
- "A String",
- ],
- "positiveVideoDurationSegments": [
- "A String",
- ],
- "positiveAudienceSegments": [
- "A String",
- ],
- "negativeDeviceCategories": [
- "A String",
- ],
- "positiveAdTypeSegments": [
- "A String",
- ],
- "negativeAdTypeSegments": [
- "A String",
- ],
- },
- "endDate": { # The end date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "termsAttributes": [ # A list of terms attributes.
- "A String",
- ],
- "startDate": { # The start date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "buyerBillingType": "A String", # The buyer billing type.
- "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
- "monetizerType": "A String", # The monetizer type.
- "targetByDealId": True or False, # Whether to target by deal id.
- "adSlots": [ # The particular ad slots targeted by the offer.
- {
- "name": "A String",
- "description": "A String",
- "channelId": 42,
- "channelCode": "A String",
- "webPropertyId": 42,
- "size": "A String",
- },
- ],
- "advertisers": [ # A list of advertisers for this offer.
- {
- "brands": [
- {
- "advertiserId": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "status": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "minimumSpendMicros": "A String", # The minimum spend for the offer.
- "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
- "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
- "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
- "dealPremium": { # The premium terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
- "audienceSegment": { # The audience segment for the offer.
- "numCookies": "A String",
- "description": "A String",
- "name": "A String",
- "id": "A String",
- },
- "description": "A String", # A description for these terms.
- "billingTerms": "A String", # The billing terms.
- "semiTransparent": True or False, # Whether this offer is semi-transparent.
- "minimumTrueLooks": "A String", # The minimum true looks for the offer.
- "cpm": { # The cpm terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "isReservation": True or False, # Whether the offer is a reservation.
- "descriptiveName": "A String", # A descriptive name for these terms.
- "urls": [ # The urls applicable to the offer.
- "A String",
- ],
- "estimatedSpend": { # The estimated spend for the offer.
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "emailContacts": [ # The list of email contacts for this offer.
- "A String",
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(body)</code>
- <pre>Creates or updates the requested offer.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # The status of this offer.
- "kind": "adexchangebuyer#offer",
- "labelNames": [ # The list of label names applicable to this offer.
- "A String",
- ],
- "pointOfContact": "A String", # The point of contact for this offer.
- "isOpen": True or False, # Whether this offer is open.
- "creator": { # The creator of this offer.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "closedToDealParties": [ # The list of buyer or seller parties this offer is closed to.
- {
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- ],
- "billedBuyer": { # The billed buyer; For buyer initiated offers, buying through an intermediary.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "offerId": "A String", # The unique ID of this offer.
- "openToDealParties": [ # The list of buyer or seller parties this offer is open to.
- {
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- ],
- "offerState": "A String", # The state of this offer.
- "anonymous": True or False, # Whether this offer is anonymous.
- "terms": { # The terms of this offer.
- "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
- "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
- "positiveIcmInterests": [
- "A String",
- ],
- "positiveInventorySlots": [
- "A String",
- ],
- "negativeSiteUrls": [
- "A String",
- ],
- "positiveIcmBrands": [
- "A String",
- ],
- "negativeXfpPlacements": [
- "A String",
- ],
- "positiveVideoAdPositionSegments": [
- "A String",
- ],
- "negativeIcmInterests": [
- "A String",
- ],
- "negativeAudienceSegments": [
- "A String",
- ],
- "positiveOperatingSystems": [
- "A String",
- ],
- "negativeOperatingSystems": [
- "A String",
- ],
- "negativeIcmBrands": [
- "A String",
- ],
- "positiveLocations": [
- "A String",
- ],
- "negativeMobileApps": [
- "A String",
- ],
- "positiveDeviceCategories": [
- "A String",
- ],
- "negativeAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeInventorySlots": [
- "A String",
- ],
- "negativeVideoAdPositionSegments": [
- "A String",
- ],
- "negativeVideoDurationSegments": [
- "A String",
- ],
- "positiveSizes": [
- "A String",
- ],
- "positiveXfpAdSlots": [
- "A String",
- ],
- "positiveKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "positiveSiteUrls": [
- "A String",
- ],
- "positiveMobileApps": [
- "A String",
- ],
- "negativeKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "negativeSizes": [
- "A String",
- ],
- "positiveOperatingSystemVersions": [
- "A String",
- ],
- "negativeLocations": [
- "A String",
- ],
- "positiveAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeOperatingSystemVersions": [
- "A String",
- ],
- "positiveXfpPlacements": [
- "A String",
- ],
- "negativeXfpAdSlots": [
- "A String",
- ],
- "positiveVideoDurationSegments": [
- "A String",
- ],
- "positiveAudienceSegments": [
- "A String",
- ],
- "negativeDeviceCategories": [
- "A String",
- ],
- "positiveAdTypeSegments": [
- "A String",
- ],
- "negativeAdTypeSegments": [
- "A String",
- ],
- },
- "endDate": { # The end date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "termsAttributes": [ # A list of terms attributes.
- "A String",
- ],
- "startDate": { # The start date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "buyerBillingType": "A String", # The buyer billing type.
- "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
- "monetizerType": "A String", # The monetizer type.
- "targetByDealId": True or False, # Whether to target by deal id.
- "adSlots": [ # The particular ad slots targeted by the offer.
- {
- "name": "A String",
- "description": "A String",
- "channelId": 42,
- "channelCode": "A String",
- "webPropertyId": 42,
- "size": "A String",
- },
- ],
- "advertisers": [ # A list of advertisers for this offer.
- {
- "brands": [
- {
- "advertiserId": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "status": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "minimumSpendMicros": "A String", # The minimum spend for the offer.
- "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
- "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
- "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
- "dealPremium": { # The premium terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
- "audienceSegment": { # The audience segment for the offer.
- "numCookies": "A String",
- "description": "A String",
- "name": "A String",
- "id": "A String",
- },
- "description": "A String", # A description for these terms.
- "billingTerms": "A String", # The billing terms.
- "semiTransparent": True or False, # Whether this offer is semi-transparent.
- "minimumTrueLooks": "A String", # The minimum true looks for the offer.
- "cpm": { # The cpm terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "isReservation": True or False, # Whether the offer is a reservation.
- "descriptiveName": "A String", # A descriptive name for these terms.
- "urls": [ # The urls applicable to the offer.
- "A String",
- ],
- "estimatedSpend": { # The estimated spend for the offer.
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "emailContacts": [ # The list of email contacts for this offer.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # The status of this offer.
- "kind": "adexchangebuyer#offer",
- "labelNames": [ # The list of label names applicable to this offer.
- "A String",
- ],
- "pointOfContact": "A String", # The point of contact for this offer.
- "isOpen": True or False, # Whether this offer is open.
- "creator": { # The creator of this offer.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "closedToDealParties": [ # The list of buyer or seller parties this offer is closed to.
- {
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- ],
- "billedBuyer": { # The billed buyer; For buyer initiated offers, buying through an intermediary.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "offerId": "A String", # The unique ID of this offer.
- "openToDealParties": [ # The list of buyer or seller parties this offer is open to.
- {
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- ],
- "offerState": "A String", # The state of this offer.
- "anonymous": True or False, # Whether this offer is anonymous.
- "terms": { # The terms of this offer.
- "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
- "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
- "positiveIcmInterests": [
- "A String",
- ],
- "positiveInventorySlots": [
- "A String",
- ],
- "negativeSiteUrls": [
- "A String",
- ],
- "positiveIcmBrands": [
- "A String",
- ],
- "negativeXfpPlacements": [
- "A String",
- ],
- "positiveVideoAdPositionSegments": [
- "A String",
- ],
- "negativeIcmInterests": [
- "A String",
- ],
- "negativeAudienceSegments": [
- "A String",
- ],
- "positiveOperatingSystems": [
- "A String",
- ],
- "negativeOperatingSystems": [
- "A String",
- ],
- "negativeIcmBrands": [
- "A String",
- ],
- "positiveLocations": [
- "A String",
- ],
- "negativeMobileApps": [
- "A String",
- ],
- "positiveDeviceCategories": [
- "A String",
- ],
- "negativeAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeInventorySlots": [
- "A String",
- ],
- "negativeVideoAdPositionSegments": [
- "A String",
- ],
- "negativeVideoDurationSegments": [
- "A String",
- ],
- "positiveSizes": [
- "A String",
- ],
- "positiveXfpAdSlots": [
- "A String",
- ],
- "positiveKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "positiveSiteUrls": [
- "A String",
- ],
- "positiveMobileApps": [
- "A String",
- ],
- "negativeKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "negativeSizes": [
- "A String",
- ],
- "positiveOperatingSystemVersions": [
- "A String",
- ],
- "negativeLocations": [
- "A String",
- ],
- "positiveAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeOperatingSystemVersions": [
- "A String",
- ],
- "positiveXfpPlacements": [
- "A String",
- ],
- "negativeXfpAdSlots": [
- "A String",
- ],
- "positiveVideoDurationSegments": [
- "A String",
- ],
- "positiveAudienceSegments": [
- "A String",
- ],
- "negativeDeviceCategories": [
- "A String",
- ],
- "positiveAdTypeSegments": [
- "A String",
- ],
- "negativeAdTypeSegments": [
- "A String",
- ],
- },
- "endDate": { # The end date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "termsAttributes": [ # A list of terms attributes.
- "A String",
- ],
- "startDate": { # The start date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "buyerBillingType": "A String", # The buyer billing type.
- "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
- "monetizerType": "A String", # The monetizer type.
- "targetByDealId": True or False, # Whether to target by deal id.
- "adSlots": [ # The particular ad slots targeted by the offer.
- {
- "name": "A String",
- "description": "A String",
- "channelId": 42,
- "channelCode": "A String",
- "webPropertyId": 42,
- "size": "A String",
- },
- ],
- "advertisers": [ # A list of advertisers for this offer.
- {
- "brands": [
- {
- "advertiserId": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "status": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "minimumSpendMicros": "A String", # The minimum spend for the offer.
- "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
- "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
- "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
- "dealPremium": { # The premium terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
- "audienceSegment": { # The audience segment for the offer.
- "numCookies": "A String",
- "description": "A String",
- "name": "A String",
- "id": "A String",
- },
- "description": "A String", # A description for these terms.
- "billingTerms": "A String", # The billing terms.
- "semiTransparent": True or False, # Whether this offer is semi-transparent.
- "minimumTrueLooks": "A String", # The minimum true looks for the offer.
- "cpm": { # The cpm terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "isReservation": True or False, # Whether the offer is a reservation.
- "descriptiveName": "A String", # A descriptive name for these terms.
- "urls": [ # The urls applicable to the offer.
- "A String",
- ],
- "estimatedSpend": { # The estimated spend for the offer.
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "emailContacts": [ # The list of email contacts for this offer.
- "A String",
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list()</code>
- <pre>Lists all offers the authenticated user has access to.
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "kind": "adexchangebuyer#offersList",
- "offers": [
- {
- "status": "A String", # The status of this offer.
- "kind": "adexchangebuyer#offer",
- "labelNames": [ # The list of label names applicable to this offer.
- "A String",
- ],
- "pointOfContact": "A String", # The point of contact for this offer.
- "isOpen": True or False, # Whether this offer is open.
- "creator": { # The creator of this offer.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "closedToDealParties": [ # The list of buyer or seller parties this offer is closed to.
- {
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- ],
- "billedBuyer": { # The billed buyer; For buyer initiated offers, buying through an intermediary.
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- "offerId": "A String", # The unique ID of this offer.
- "openToDealParties": [ # The list of buyer or seller parties this offer is open to.
- {
- "buyer": {
- "enabledForPreferredDeals": True or False,
- "displayName": "A String",
- "customerId": 42,
- "enabledForInterestTargetingDeals": True or False,
- "sponsorAccountId": 42,
- "id": 42,
- "accountId": 42,
- },
- "webProperty": {
- "enabledForPreferredDeals": True or False,
- "name": "A String",
- "syndicationProduct": "A String",
- "allowInterestTargetedAds": True or False,
- "siteUrls": [
- "A String",
- ],
- "propertyCode": "A String",
- "id": 42,
- },
- "customerId": 42,
- "name": "A String",
- "buyerSellerRole": "A String",
- },
- ],
- "offerState": "A String", # The state of this offer.
- "anonymous": True or False, # Whether this offer is anonymous.
- "terms": { # The terms of this offer.
- "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
- "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
- "positiveIcmInterests": [
- "A String",
- ],
- "positiveInventorySlots": [
- "A String",
- ],
- "negativeSiteUrls": [
- "A String",
- ],
- "positiveIcmBrands": [
- "A String",
- ],
- "negativeXfpPlacements": [
- "A String",
- ],
- "positiveVideoAdPositionSegments": [
- "A String",
- ],
- "negativeIcmInterests": [
- "A String",
- ],
- "negativeAudienceSegments": [
- "A String",
- ],
- "positiveOperatingSystems": [
- "A String",
- ],
- "negativeOperatingSystems": [
- "A String",
- ],
- "negativeIcmBrands": [
- "A String",
- ],
- "positiveLocations": [
- "A String",
- ],
- "negativeMobileApps": [
- "A String",
- ],
- "positiveDeviceCategories": [
- "A String",
- ],
- "negativeAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeInventorySlots": [
- "A String",
- ],
- "negativeVideoAdPositionSegments": [
- "A String",
- ],
- "negativeVideoDurationSegments": [
- "A String",
- ],
- "positiveSizes": [
- "A String",
- ],
- "positiveXfpAdSlots": [
- "A String",
- ],
- "positiveKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "positiveSiteUrls": [
- "A String",
- ],
- "positiveMobileApps": [
- "A String",
- ],
- "negativeKeyValues": [
- {
- "keyName": "A String",
- "value": "A String",
- },
- ],
- "negativeSizes": [
- "A String",
- ],
- "positiveOperatingSystemVersions": [
- "A String",
- ],
- "negativeLocations": [
- "A String",
- ],
- "positiveAdSizes": [
- {
- "width": 42,
- "height": 42,
- },
- ],
- "negativeOperatingSystemVersions": [
- "A String",
- ],
- "positiveXfpPlacements": [
- "A String",
- ],
- "negativeXfpAdSlots": [
- "A String",
- ],
- "positiveVideoDurationSegments": [
- "A String",
- ],
- "positiveAudienceSegments": [
- "A String",
- ],
- "negativeDeviceCategories": [
- "A String",
- ],
- "positiveAdTypeSegments": [
- "A String",
- ],
- "negativeAdTypeSegments": [
- "A String",
- ],
- },
- "endDate": { # The end date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "termsAttributes": [ # A list of terms attributes.
- "A String",
- ],
- "startDate": { # The start date for the offer.
- "timeZoneId": "A String",
- "hour": 42,
- "month": 42,
- "second": 42,
- "year": 42,
- "day": 42,
- "minute": 42,
- },
- "buyerBillingType": "A String", # The buyer billing type.
- "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
- "monetizerType": "A String", # The monetizer type.
- "targetByDealId": True or False, # Whether to target by deal id.
- "adSlots": [ # The particular ad slots targeted by the offer.
- {
- "name": "A String",
- "description": "A String",
- "channelId": 42,
- "channelCode": "A String",
- "webPropertyId": 42,
- "size": "A String",
- },
- ],
- "advertisers": [ # A list of advertisers for this offer.
- {
- "brands": [
- {
- "advertiserId": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "status": "A String",
- "id": "A String",
- "name": "A String",
- },
- ],
- "minimumSpendMicros": "A String", # The minimum spend for the offer.
- "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
- "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
- "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
- "dealPremium": { # The premium terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
- "audienceSegment": { # The audience segment for the offer.
- "numCookies": "A String",
- "description": "A String",
- "name": "A String",
- "id": "A String",
- },
- "description": "A String", # A description for these terms.
- "billingTerms": "A String", # The billing terms.
- "semiTransparent": True or False, # Whether this offer is semi-transparent.
- "minimumTrueLooks": "A String", # The minimum true looks for the offer.
- "cpm": { # The cpm terms.
- "micros": "A String",
- "currencyCode": "A String",
- },
- "isReservation": True or False, # Whether the offer is a reservation.
- "descriptiveName": "A String", # A descriptive name for these terms.
- "urls": [ # The urls applicable to the offer.
- "A String",
- ],
- "estimatedSpend": { # The estimated spend for the offer.
- "micros": "A String",
- "currencyCode": "A String",
- },
- },
- "emailContacts": [ # The list of email contacts for this offer.
- "A String",
- ],
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/adexchangeseller_v1.adclients.html b/docs/dyn/adexchangeseller_v1.adclients.html
new file mode 100644
index 0000000..0fa196e
--- /dev/null
+++ b/docs/dyn/adexchangeseller_v1.adclients.html
@@ -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="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.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 Ad Exchange 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 Ad Exchange 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": "adexchangeseller#adClient", # Kind of resource this is, in this case adexchangeseller#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": "adexchangeseller#adClients", # Kind of list this is, in this case adexchangeseller#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>
\ No newline at end of file
diff --git a/docs/dyn/adexchangeseller_v1.adunits.customchannels.html b/docs/dyn/adexchangeseller_v1.adunits.customchannels.html
new file mode 100644
index 0000000..23c42c7
--- /dev/null
+++ b/docs/dyn/adexchangeseller_v1.adunits.customchannels.html
@@ -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="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.adunits.html">adunits</a> . <a href="adexchangeseller_v1.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": "adexchangeseller#customChannel", # Kind of resource this is, in this case adexchangeseller#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": "adexchangeseller#customChannels", # Kind of list this is, in this case adexchangeseller#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>
\ No newline at end of file
diff --git a/docs/dyn/adexchangeseller_v1.adunits.html b/docs/dyn/adexchangeseller_v1.adunits.html
new file mode 100644
index 0000000..103214d
--- /dev/null
+++ b/docs/dyn/adexchangeseller_v1.adunits.html
@@ -0,0 +1,165 @@
+<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="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.adunits.html">adunits</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="adexchangeseller_v1.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="#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 Ad Exchange 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": "adexchangeseller#adUnit", # Kind of resource this is, in this case adexchangeseller#adUnit.
+ "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
+ "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.
+ "name": "A String", # Name of this ad unit.
+ }</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 Ad Exchange 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": "adexchangeseller#adUnit", # Kind of resource this is, in this case adexchangeseller#adUnit.
+ "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
+ "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.
+ "name": "A String", # Name of this ad unit.
+ },
+ ],
+ "kind": "adexchangeseller#adUnits", # Kind of list this is, in this case adexchangeseller#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>
\ No newline at end of file
diff --git a/docs/dyn/adexchangeseller_v1.customchannels.adunits.html b/docs/dyn/adexchangeseller_v1.customchannels.adunits.html
new file mode 100644
index 0000000..52f5a88
--- /dev/null
+++ b/docs/dyn/adexchangeseller_v1.customchannels.adunits.html
@@ -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="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.customchannels.html">customchannels</a> . <a href="adexchangeseller_v1.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": "adexchangeseller#adUnit", # Kind of resource this is, in this case adexchangeseller#adUnit.
+ "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
+ "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.
+ "name": "A String", # Name of this ad unit.
+ },
+ ],
+ "kind": "adexchangeseller#adUnits", # Kind of list this is, in this case adexchangeseller#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>
\ No newline at end of file
diff --git a/docs/dyn/adexchangeseller_v1.customchannels.html b/docs/dyn/adexchangeseller_v1.customchannels.html
new file mode 100644
index 0000000..0d324f8
--- /dev/null
+++ b/docs/dyn/adexchangeseller_v1.customchannels.html
@@ -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="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.customchannels.html">customchannels</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="adexchangeseller_v1.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 Ad Exchange 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": "adexchangeseller#customChannel", # Kind of resource this is, in this case adexchangeseller#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 Ad Exchange 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": "adexchangeseller#customChannel", # Kind of resource this is, in this case adexchangeseller#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": "adexchangeseller#customChannels", # Kind of list this is, in this case adexchangeseller#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>
\ No newline at end of file
diff --git a/docs/dyn/gan_v1beta1.html b/docs/dyn/adexchangeseller_v1.html
similarity index 73%
rename from docs/dyn/gan_v1beta1.html
rename to docs/dyn/adexchangeseller_v1.html
index a51a20f..683a6ef 100644
--- a/docs/dyn/gan_v1beta1.html
+++ b/docs/dyn/adexchangeseller_v1.html
@@ -72,39 +72,34 @@
</style>
-<h1><a href="gan_v1beta1.html">Google Affiliate Network API</a></h1>
+<h1><a href="adexchangeseller_v1.html">Ad Exchange Seller API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="gan_v1beta1.advertisers.html">advertisers()</a></code>
+ <code><a href="adexchangeseller_v1.adclients.html">adclients()</a></code>
</p>
-<p class="firstline">Returns the advertisers Resource.</p>
+<p class="firstline">Returns the adclients Resource.</p>
<p class="toc_element">
- <code><a href="gan_v1beta1.ccOffers.html">ccOffers()</a></code>
+ <code><a href="adexchangeseller_v1.adunits.html">adunits()</a></code>
</p>
-<p class="firstline">Returns the ccOffers Resource.</p>
+<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
- <code><a href="gan_v1beta1.events.html">events()</a></code>
+ <code><a href="adexchangeseller_v1.customchannels.html">customchannels()</a></code>
</p>
-<p class="firstline">Returns the events Resource.</p>
+<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
- <code><a href="gan_v1beta1.links.html">links()</a></code>
-</p>
-<p class="firstline">Returns the links Resource.</p>
-
-<p class="toc_element">
- <code><a href="gan_v1beta1.publishers.html">publishers()</a></code>
-</p>
-<p class="firstline">Returns the publishers Resource.</p>
-
-<p class="toc_element">
- <code><a href="gan_v1beta1.reports.html">reports()</a></code>
+ <code><a href="adexchangeseller_v1.reports.html">reports()</a></code>
</p>
<p class="firstline">Returns the reports Resource.</p>
<p class="toc_element">
+ <code><a href="adexchangeseller_v1.urlchannels.html">urlchannels()</a></code>
+</p>
+<p class="firstline">Returns the urlchannels Resource.</p>
+
+<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
<h3>Method Details</h3>
diff --git a/docs/dyn/adexchangeseller_v1.reports.html b/docs/dyn/adexchangeseller_v1.reports.html
new file mode 100644
index 0000000..4b2e40e
--- /dev/null
+++ b/docs/dyn/adexchangeseller_v1.reports.html
@@ -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="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.reports.html">reports</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="adexchangeseller_v1.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, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</a></code></p>
+<p class="firstline">Generate an Ad Exchange 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, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</a></code></p>
+<p class="firstline">Generate an Ad Exchange 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, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</code>
+ <pre>Generate an Ad Exchange 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)
+ 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)
+ 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)
+ maxResults: integer, The maximum number of rows of report data to return.
+ dimension: string, Dimensions to base the report on. (repeated)
+ startIndex: integer, Index of the first row of report data to return.
+ filter: string, Filters to be run on the report. (repeated)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adexchangeseller#report", # Kind this is, in this case adexchangeseller#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, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</code>
+ <pre>Generate an Ad Exchange 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)
+ 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)
+ 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)
+ maxResults: integer, The maximum number of rows of report data to return.
+ dimension: string, Dimensions to base the report on. (repeated)
+ startIndex: integer, Index of the first row of report data to return.
+ filter: string, Filters to be run on the report. (repeated)
+
+Returns:
+ The media object as a string.
+
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/adexchangeseller_v1.reports.saved.html b/docs/dyn/adexchangeseller_v1.reports.saved.html
new file mode 100644
index 0000000..33ec795
--- /dev/null
+++ b/docs/dyn/adexchangeseller_v1.reports.saved.html
@@ -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="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.reports.html">reports</a> . <a href="adexchangeseller_v1.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 Ad Exchange 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 Ad Exchange 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 Ad Exchange 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": "adexchangeseller#report", # Kind this is, in this case adexchangeseller#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 Ad Exchange 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": "adexchangeseller#savedReport", # Kind of resource this is, in this case adexchangeseller#savedReport.
+ "id": "A String", # Unique identifier of this saved report.
+ "name": "A String", # This saved report's name.
+ },
+ ],
+ "kind": "adexchangeseller#savedReports", # Kind of list this is, in this case adexchangeseller#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>
\ No newline at end of file
diff --git a/docs/dyn/adexchangeseller_v1.urlchannels.html b/docs/dyn/adexchangeseller_v1.urlchannels.html
new file mode 100644
index 0000000..0e8b9b4
--- /dev/null
+++ b/docs/dyn/adexchangeseller_v1.urlchannels.html
@@ -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="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.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 Ad Exchange 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 Ad Exchange 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": "adexchangeseller#urlChannel", # Kind of resource this is, in this case adexchangeseller#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": "adexchangeseller#urlChannels", # Kind of list this is, in this case adexchangeseller#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>
\ No newline at end of file
diff --git a/docs/dyn/adexchangeseller_v1_1.html b/docs/dyn/adexchangeseller_v1_1.html
index 98714d5..7c08d0d 100644
--- a/docs/dyn/adexchangeseller_v1_1.html
+++ b/docs/dyn/adexchangeseller_v1_1.html
@@ -119,4 +119,25 @@
</p>
<p class="firstline">Returns the urlchannels Resource.</p>
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_datatransfer_v1.applications.html b/docs/dyn/admin_datatransfer_v1.applications.html
new file mode 100644
index 0000000..1c4799b
--- /dev/null
+++ b/docs/dyn/admin_datatransfer_v1.applications.html
@@ -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="admin_datatransfer_v1.html">Admin Data Transfer API</a> . <a href="admin_datatransfer_v1.applications.html">applications</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(applicationId)</a></code></p>
+<p class="firstline">Retrieves information about an application for the given application ID.</p>
+<p class="toc_element">
+ <code><a href="#list">list(pageToken=None, maxResults=None, customerId=None)</a></code></p>
+<p class="firstline">Lists the applications available for data transfer for a customer.</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(applicationId)</code>
+ <pre>Retrieves information about an application for the given application ID.
+
+Args:
+ applicationId: string, ID of the application resource to be retrieved. (required)
+
+Returns:
+ An object of the form:
+
+ { # The JSON template for an Application resource.
+ "kind": "admin#datatransfer#ApplicationResource", # Identifies the resource as a DataTransfer Application Resource.
+ "etag": "A String", # Etag of the resource.
+ "transferParams": [ # The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered.
+ { # Template for application transfer parameters.
+ "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
+ "A String",
+ ],
+ "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
+ },
+ ],
+ "id": "A String", # The application's ID.
+ "name": "A String", # The application's name.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(pageToken=None, maxResults=None, customerId=None)</code>
+ <pre>Lists the applications available for data transfer for a customer.
+
+Args:
+ pageToken: string, Token to specify next page in the list.
+ maxResults: integer, Maximum number of results to return. Default is 100.
+ customerId: string, Immutable ID of the Google Apps account.
+
+Returns:
+ An object of the form:
+
+ { # Template for a collection of Applications.
+ "nextPageToken": "A String", # Continuation token which will be used to specify next page in list API.
+ "applications": [ # List of applications that support data transfer and are also installed for the customer.
+ { # The JSON template for an Application resource.
+ "kind": "admin#datatransfer#ApplicationResource", # Identifies the resource as a DataTransfer Application Resource.
+ "etag": "A String", # Etag of the resource.
+ "transferParams": [ # The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered.
+ { # Template for application transfer parameters.
+ "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
+ "A String",
+ ],
+ "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
+ },
+ ],
+ "id": "A String", # The application's ID.
+ "name": "A String", # The application's name.
+ },
+ ],
+ "kind": "admin#datatransfer#applicationsList", # Identifies the resource as a collection of Applications.
+ "etag": "A String", # ETag of the resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.html b/docs/dyn/admin_datatransfer_v1.html
similarity index 85%
copy from docs/dyn/serviceregistry_alpha.html
copy to docs/dyn/admin_datatransfer_v1.html
index fe160ea..7e5aeb0 100644
--- a/docs/dyn/serviceregistry_alpha.html
+++ b/docs/dyn/admin_datatransfer_v1.html
@@ -72,17 +72,17 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a></h1>
+<h1><a href="admin_datatransfer_v1.html">Admin Data Transfer API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="serviceregistry_alpha.endpoints.html">endpoints()</a></code>
+ <code><a href="admin_datatransfer_v1.applications.html">applications()</a></code>
</p>
-<p class="firstline">Returns the endpoints Resource.</p>
+<p class="firstline">Returns the applications Resource.</p>
<p class="toc_element">
- <code><a href="serviceregistry_alpha.operations.html">operations()</a></code>
+ <code><a href="admin_datatransfer_v1.transfers.html">transfers()</a></code>
</p>
-<p class="firstline">Returns the operations Resource.</p>
+<p class="firstline">Returns the transfers Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/admin_datatransfer_v1.transfers.html b/docs/dyn/admin_datatransfer_v1.transfers.html
new file mode 100644
index 0000000..7d7d623
--- /dev/null
+++ b/docs/dyn/admin_datatransfer_v1.transfers.html
@@ -0,0 +1,247 @@
+<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_datatransfer_v1.html">Admin Data Transfer API</a> . <a href="admin_datatransfer_v1.transfers.html">transfers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(dataTransferId)</a></code></p>
+<p class="firstline">Retrieves a data transfer request by its resource ID.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(body)</a></code></p>
+<p class="firstline">Inserts a data transfer request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(status=None, oldOwnerUserId=None, pageToken=None, maxResults=None, newOwnerUserId=None, customerId=None)</a></code></p>
+<p class="firstline">Lists the transfers for a customer by source user, destination user, or status.</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(dataTransferId)</code>
+ <pre>Retrieves a data transfer request by its resource ID.
+
+Args:
+ dataTransferId: string, ID of the resource to be retrieved. This is returned in the response from the insert method. (required)
+
+Returns:
+ An object of the form:
+
+ { # The JSON template for a DataTransfer resource.
+ "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
+ "requestTime": "A String", # The time at which the data transfer was requested (Read-only).
+ "applicationDataTransfers": [ # List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.
+ { # Template to map fields of ApplicationDataTransfer resource.
+ "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.
+ { # Template for application transfer parameters.
+ "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
+ "A String",
+ ],
+ "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
+ },
+ ],
+ "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
+ "applicationId": "A String", # The application's ID.
+ },
+ ],
+ "newOwnerUserId": "A String", # ID of the user to whom the data is being transfered.
+ "oldOwnerUserId": "A String", # ID of the user whose data is being transfered.
+ "etag": "A String", # ETag of the resource.
+ "overallTransferStatusCode": "A String", # Overall transfer status (Read-only).
+ "id": "A String", # The transfer's ID (Read-only).
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(body)</code>
+ <pre>Inserts a data transfer request.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The JSON template for a DataTransfer resource.
+ "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
+ "requestTime": "A String", # The time at which the data transfer was requested (Read-only).
+ "applicationDataTransfers": [ # List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.
+ { # Template to map fields of ApplicationDataTransfer resource.
+ "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.
+ { # Template for application transfer parameters.
+ "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
+ "A String",
+ ],
+ "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
+ },
+ ],
+ "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
+ "applicationId": "A String", # The application's ID.
+ },
+ ],
+ "newOwnerUserId": "A String", # ID of the user to whom the data is being transfered.
+ "oldOwnerUserId": "A String", # ID of the user whose data is being transfered.
+ "etag": "A String", # ETag of the resource.
+ "overallTransferStatusCode": "A String", # Overall transfer status (Read-only).
+ "id": "A String", # The transfer's ID (Read-only).
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # The JSON template for a DataTransfer resource.
+ "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
+ "requestTime": "A String", # The time at which the data transfer was requested (Read-only).
+ "applicationDataTransfers": [ # List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.
+ { # Template to map fields of ApplicationDataTransfer resource.
+ "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.
+ { # Template for application transfer parameters.
+ "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
+ "A String",
+ ],
+ "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
+ },
+ ],
+ "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
+ "applicationId": "A String", # The application's ID.
+ },
+ ],
+ "newOwnerUserId": "A String", # ID of the user to whom the data is being transfered.
+ "oldOwnerUserId": "A String", # ID of the user whose data is being transfered.
+ "etag": "A String", # ETag of the resource.
+ "overallTransferStatusCode": "A String", # Overall transfer status (Read-only).
+ "id": "A String", # The transfer's ID (Read-only).
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(status=None, oldOwnerUserId=None, pageToken=None, maxResults=None, newOwnerUserId=None, customerId=None)</code>
+ <pre>Lists the transfers for a customer by source user, destination user, or status.
+
+Args:
+ status: string, Status of the transfer.
+ oldOwnerUserId: string, Source user's profile ID.
+ pageToken: string, Token to specify the next page in the list.
+ maxResults: integer, Maximum number of results to return. Default is 100.
+ newOwnerUserId: string, Destination user's profile ID.
+ customerId: string, Immutable ID of the Google Apps account.
+
+Returns:
+ An object of the form:
+
+ { # Template for a collection of DataTransfer resources.
+ "nextPageToken": "A String", # Continuation token which will be used to specify next page in list API.
+ "kind": "admin#datatransfer#dataTransfersList", # Identifies the resource as a collection of data transfer requests.
+ "etag": "A String", # ETag of the resource.
+ "dataTransfers": [ # List of data transfer requests.
+ { # The JSON template for a DataTransfer resource.
+ "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
+ "requestTime": "A String", # The time at which the data transfer was requested (Read-only).
+ "applicationDataTransfers": [ # List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.
+ { # Template to map fields of ApplicationDataTransfer resource.
+ "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.
+ { # Template for application transfer parameters.
+ "value": [ # The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
+ "A String",
+ ],
+ "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
+ },
+ ],
+ "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
+ "applicationId": "A String", # The application's ID.
+ },
+ ],
+ "newOwnerUserId": "A String", # ID of the user to whom the data is being transfered.
+ "oldOwnerUserId": "A String", # ID of the user whose data is being transfered.
+ "etag": "A String", # ETag of the resource.
+ "overallTransferStatusCode": "A String", # Overall transfer status (Read-only).
+ "id": "A String", # The transfer's ID (Read-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>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.asps.html b/docs/dyn/admin_directory_v1.asps.html
new file mode 100644
index 0000000..dd11a2d
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.asps.html
@@ -0,0 +1,146 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.asps.html">asps</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(userKey, codeId)</a></code></p>
+<p class="firstline">Delete an ASP issued by a user.</p>
+<p class="toc_element">
+ <code><a href="#get">get(userKey, codeId)</a></code></p>
+<p class="firstline">Get information about an ASP issued by a user.</p>
+<p class="toc_element">
+ <code><a href="#list">list(userKey)</a></code></p>
+<p class="firstline">List the ASPs issued by a user.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(userKey, codeId)</code>
+ <pre>Delete an ASP issued by a user.
+
+Args:
+ userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
+ codeId: integer, The unique ID of the ASP to be deleted. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(userKey, codeId)</code>
+ <pre>Get information about an ASP issued by a user.
+
+Args:
+ userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
+ codeId: integer, The unique ID of the ASP. (required)
+
+Returns:
+ An object of the form:
+
+ { # The template that returns individual ASP (Access Code) data.
+ "kind": "admin#directory#asp", # The type of the API resource. This is always admin#directory#asp.
+ "name": "A String", # The name of the application that the user, represented by their userId, entered when the ASP was created.
+ "lastTimeUsed": "A String", # The time when the ASP was last used. Expressed in Unix time format.
+ "creationTime": "A String", # The time when the ASP was created. Expressed in Unix time format.
+ "etag": "A String", # ETag of the ASP.
+ "codeId": 42, # The unique ID of the ASP.
+ "userKey": "A String", # The unique ID of the user who issued the ASP.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(userKey)</code>
+ <pre>List the ASPs issued by a user.
+
+Args:
+ userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "items": [ # A list of ASP resources.
+ { # The template that returns individual ASP (Access Code) data.
+ "kind": "admin#directory#asp", # The type of the API resource. This is always admin#directory#asp.
+ "name": "A String", # The name of the application that the user, represented by their userId, entered when the ASP was created.
+ "lastTimeUsed": "A String", # The time when the ASP was last used. Expressed in Unix time format.
+ "creationTime": "A String", # The time when the ASP was created. Expressed in Unix time format.
+ "etag": "A String", # ETag of the ASP.
+ "codeId": 42, # The unique ID of the ASP.
+ "userKey": "A String", # The unique ID of the user who issued the ASP.
+ },
+ ],
+ "kind": "admin#directory#aspList", # The type of the API resource. This is always admin#directory#aspList.
+ "etag": "A String", # ETag of the resource.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.channels.html b/docs/dyn/admin_directory_v1.channels.html
new file mode 100644
index 0000000..c7edb2a
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.channels.html
@@ -0,0 +1,107 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.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">Stop watching resources through this channel</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="stop">stop(body)</code>
+ <pre>Stop watching resources through this channel
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An notification channel used to watch for resource changes.
+ "resourceUri": "A String", # A version-specific identifier for the watched resource.
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+ "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+ "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+ "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+ "params": { # Additional parameters controlling delivery channel behavior. Optional.
+ "a_key": "A String", # Declares a new parameter by name.
+ },
+ "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+ "address": "A String", # The address where notifications are delivered for this channel.
+ "type": "A String", # The type of delivery mechanism used for this channel.
+ "id": "A String", # A UUID or similar unique string that identifies this channel.
+ }
+
+</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.chromeosdevices.html b/docs/dyn/admin_directory_v1.chromeosdevices.html
new file mode 100644
index 0000000..bf643c1
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.chromeosdevices.html
@@ -0,0 +1,448 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.chromeosdevices.html">chromeosdevices</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#action">action(customerId, resourceId, body)</a></code></p>
+<p class="firstline">Take action on Chrome OS Device</p>
+<p class="toc_element">
+ <code><a href="#get">get(customerId, deviceId, projection=None)</a></code></p>
+<p class="firstline">Retrieve Chrome OS Device</p>
+<p class="toc_element">
+ <code><a href="#list">list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None)</a></code></p>
+<p class="firstline">Retrieve all Chrome OS Devices of a customer (paginated)</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(customerId, deviceId, body, projection=None)</a></code></p>
+<p class="firstline">Update Chrome OS Device. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(customerId, deviceId, body, projection=None)</a></code></p>
+<p class="firstline">Update Chrome OS Device</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="action">action(customerId, resourceId, body)</code>
+ <pre>Take action on Chrome OS Device
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ resourceId: string, Immutable id of Chrome OS Device (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON request template for firing actions on ChromeOs Device in Directory Devices API.
+ "action": "A String", # Action to be taken on the ChromeOs Device
+ "deprovisionReason": "A String",
+ }
+
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(customerId, deviceId, projection=None)</code>
+ <pre>Retrieve Chrome OS Device
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ deviceId: string, Immutable id of Chrome OS Device (required)
+ projection: string, Restrict information returned to a set of selected fields.
+ Allowed values
+ BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
+ FULL - Includes all metadata fields
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Chrome Os Device resource in Directory API.
+ "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
+ "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
+ "orderNumber": "A String", # Chromebook order number (Read-only)
+ "annotatedLocation": "A String", # Address or location of the device as noted by the administrator
+ "activeTimeRanges": [ # List of active time ranges (Read-only)
+ {
+ "date": "A String", # Date of usage
+ "activeTime": 42, # Duration in milliseconds
+ },
+ ],
+ "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
+ "firmwareVersion": "A String", # Chromebook firmware version (Read-only)
+ "bootMode": "A String", # Chromebook boot mode (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # OrgUnit of the device
+ "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
+ {
+ "type": "A String", # The type of the user
+ "email": "A String", # Email address of the user. Present only if the user type is managed
+ },
+ ],
+ "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
+ "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
+ "meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
+ "annotatedUser": "A String", # User of the device
+ "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
+ "platformVersion": "A String", # Chromebook platform version (Read-only)
+ "osVersion": "A String", # Chromebook Os Version (Read-only)
+ "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
+ "kind": "admin#directory#chromeosdevice", # Kind of resource this is.
+ "notes": "A String", # Notes added by the administrator
+ "serialNumber": "A String", # Chromebook serial number (Read-only)
+ "status": "A String", # status of the device (Read-only)
+ "supportEndDate": "A String", # Final date the device will be supported (Read-only)
+ "model": "A String", # Chromebook Model (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None)</code>
+ <pre>Retrieve all Chrome OS Devices of a customer (paginated)
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ orderBy: string, Column to use for sorting results
+ Allowed values
+ annotatedLocation - Chromebook location as annotated by the administrator.
+ annotatedUser - Chromebook user as annotated by administrator.
+ lastSync - Chromebook last sync.
+ notes - Chromebook notes as annotated by the administrator.
+ serialNumber - Chromebook Serial Number.
+ status - Chromebook status.
+ supportEndDate - Chromebook support end date.
+ projection: string, Restrict information returned to a set of selected fields.
+ Allowed values
+ BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
+ FULL - Includes all metadata fields
+ pageToken: string, Token to specify next page in the list
+ maxResults: integer, Maximum number of results to return. Default is 100
+ sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used
+ Allowed values
+ ASCENDING - Ascending order.
+ DESCENDING - Descending order.
+ query: string, Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?hl=en&answer=1698333
+
+Returns:
+ An object of the form:
+
+ { # JSON response template for List Chrome OS Devices operation in Directory API.
+ "nextPageToken": "A String", # Token used to access next page of this result.
+ "chromeosdevices": [ # List of Chrome OS Device objects.
+ { # JSON template for Chrome Os Device resource in Directory API.
+ "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
+ "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
+ "orderNumber": "A String", # Chromebook order number (Read-only)
+ "annotatedLocation": "A String", # Address or location of the device as noted by the administrator
+ "activeTimeRanges": [ # List of active time ranges (Read-only)
+ {
+ "date": "A String", # Date of usage
+ "activeTime": 42, # Duration in milliseconds
+ },
+ ],
+ "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
+ "firmwareVersion": "A String", # Chromebook firmware version (Read-only)
+ "bootMode": "A String", # Chromebook boot mode (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # OrgUnit of the device
+ "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
+ {
+ "type": "A String", # The type of the user
+ "email": "A String", # Email address of the user. Present only if the user type is managed
+ },
+ ],
+ "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
+ "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
+ "meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
+ "annotatedUser": "A String", # User of the device
+ "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
+ "platformVersion": "A String", # Chromebook platform version (Read-only)
+ "osVersion": "A String", # Chromebook Os Version (Read-only)
+ "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
+ "kind": "admin#directory#chromeosdevice", # Kind of resource this is.
+ "notes": "A String", # Notes added by the administrator
+ "serialNumber": "A String", # Chromebook serial number (Read-only)
+ "status": "A String", # status of the device (Read-only)
+ "supportEndDate": "A String", # Final date the device will be supported (Read-only)
+ "model": "A String", # Chromebook Model (Read-only)
+ },
+ ],
+ "etag": "A String", # ETag of the resource.
+ "kind": "admin#directory#chromeosdevices", # Kind of resource 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>
+
+<div class="method">
+ <code class="details" id="patch">patch(customerId, deviceId, body, projection=None)</code>
+ <pre>Update Chrome OS Device. This method supports patch semantics.
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ deviceId: string, Immutable id of Chrome OS Device (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Chrome Os Device resource in Directory API.
+ "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
+ "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
+ "orderNumber": "A String", # Chromebook order number (Read-only)
+ "annotatedLocation": "A String", # Address or location of the device as noted by the administrator
+ "activeTimeRanges": [ # List of active time ranges (Read-only)
+ {
+ "date": "A String", # Date of usage
+ "activeTime": 42, # Duration in milliseconds
+ },
+ ],
+ "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
+ "firmwareVersion": "A String", # Chromebook firmware version (Read-only)
+ "bootMode": "A String", # Chromebook boot mode (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # OrgUnit of the device
+ "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
+ {
+ "type": "A String", # The type of the user
+ "email": "A String", # Email address of the user. Present only if the user type is managed
+ },
+ ],
+ "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
+ "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
+ "meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
+ "annotatedUser": "A String", # User of the device
+ "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
+ "platformVersion": "A String", # Chromebook platform version (Read-only)
+ "osVersion": "A String", # Chromebook Os Version (Read-only)
+ "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
+ "kind": "admin#directory#chromeosdevice", # Kind of resource this is.
+ "notes": "A String", # Notes added by the administrator
+ "serialNumber": "A String", # Chromebook serial number (Read-only)
+ "status": "A String", # status of the device (Read-only)
+ "supportEndDate": "A String", # Final date the device will be supported (Read-only)
+ "model": "A String", # Chromebook Model (Read-only)
+ }
+
+ projection: string, Restrict information returned to a set of selected fields.
+ Allowed values
+ BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
+ FULL - Includes all metadata fields
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Chrome Os Device resource in Directory API.
+ "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
+ "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
+ "orderNumber": "A String", # Chromebook order number (Read-only)
+ "annotatedLocation": "A String", # Address or location of the device as noted by the administrator
+ "activeTimeRanges": [ # List of active time ranges (Read-only)
+ {
+ "date": "A String", # Date of usage
+ "activeTime": 42, # Duration in milliseconds
+ },
+ ],
+ "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
+ "firmwareVersion": "A String", # Chromebook firmware version (Read-only)
+ "bootMode": "A String", # Chromebook boot mode (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # OrgUnit of the device
+ "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
+ {
+ "type": "A String", # The type of the user
+ "email": "A String", # Email address of the user. Present only if the user type is managed
+ },
+ ],
+ "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
+ "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
+ "meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
+ "annotatedUser": "A String", # User of the device
+ "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
+ "platformVersion": "A String", # Chromebook platform version (Read-only)
+ "osVersion": "A String", # Chromebook Os Version (Read-only)
+ "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
+ "kind": "admin#directory#chromeosdevice", # Kind of resource this is.
+ "notes": "A String", # Notes added by the administrator
+ "serialNumber": "A String", # Chromebook serial number (Read-only)
+ "status": "A String", # status of the device (Read-only)
+ "supportEndDate": "A String", # Final date the device will be supported (Read-only)
+ "model": "A String", # Chromebook Model (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(customerId, deviceId, body, projection=None)</code>
+ <pre>Update Chrome OS Device
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ deviceId: string, Immutable id of Chrome OS Device (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Chrome Os Device resource in Directory API.
+ "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
+ "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
+ "orderNumber": "A String", # Chromebook order number (Read-only)
+ "annotatedLocation": "A String", # Address or location of the device as noted by the administrator
+ "activeTimeRanges": [ # List of active time ranges (Read-only)
+ {
+ "date": "A String", # Date of usage
+ "activeTime": 42, # Duration in milliseconds
+ },
+ ],
+ "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
+ "firmwareVersion": "A String", # Chromebook firmware version (Read-only)
+ "bootMode": "A String", # Chromebook boot mode (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # OrgUnit of the device
+ "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
+ {
+ "type": "A String", # The type of the user
+ "email": "A String", # Email address of the user. Present only if the user type is managed
+ },
+ ],
+ "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
+ "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
+ "meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
+ "annotatedUser": "A String", # User of the device
+ "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
+ "platformVersion": "A String", # Chromebook platform version (Read-only)
+ "osVersion": "A String", # Chromebook Os Version (Read-only)
+ "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
+ "kind": "admin#directory#chromeosdevice", # Kind of resource this is.
+ "notes": "A String", # Notes added by the administrator
+ "serialNumber": "A String", # Chromebook serial number (Read-only)
+ "status": "A String", # status of the device (Read-only)
+ "supportEndDate": "A String", # Final date the device will be supported (Read-only)
+ "model": "A String", # Chromebook Model (Read-only)
+ }
+
+ projection: string, Restrict information returned to a set of selected fields.
+ Allowed values
+ BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
+ FULL - Includes all metadata fields
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Chrome Os Device resource in Directory API.
+ "macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
+ "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
+ "orderNumber": "A String", # Chromebook order number (Read-only)
+ "annotatedLocation": "A String", # Address or location of the device as noted by the administrator
+ "activeTimeRanges": [ # List of active time ranges (Read-only)
+ {
+ "date": "A String", # Date of usage
+ "activeTime": 42, # Duration in milliseconds
+ },
+ ],
+ "annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
+ "firmwareVersion": "A String", # Chromebook firmware version (Read-only)
+ "bootMode": "A String", # Chromebook boot mode (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # OrgUnit of the device
+ "recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
+ {
+ "type": "A String", # The type of the user
+ "email": "A String", # Email address of the user. Present only if the user type is managed
+ },
+ ],
+ "willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
+ "ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
+ "meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
+ "annotatedUser": "A String", # User of the device
+ "deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
+ "platformVersion": "A String", # Chromebook platform version (Read-only)
+ "osVersion": "A String", # Chromebook Os Version (Read-only)
+ "lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
+ "kind": "admin#directory#chromeosdevice", # Kind of resource this is.
+ "notes": "A String", # Notes added by the administrator
+ "serialNumber": "A String", # Chromebook serial number (Read-only)
+ "status": "A String", # status of the device (Read-only)
+ "supportEndDate": "A String", # Final date the device will be supported (Read-only)
+ "model": "A String", # Chromebook Model (Read-only)
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.customers.html b/docs/dyn/admin_directory_v1.customers.html
new file mode 100644
index 0000000..b7c621a
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.customers.html
@@ -0,0 +1,236 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.customers.html">customers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(customerKey)</a></code></p>
+<p class="firstline">Retrieves a customer.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(customerKey, body)</a></code></p>
+<p class="firstline">Updates a customer. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(customerKey, body)</a></code></p>
+<p class="firstline">Updates a customer.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(customerKey)</code>
+ <pre>Retrieves a customer.
+
+Args:
+ customerKey: string, Id of the customer to be retrieved (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Customer Resource object in Directory API.
+ "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
+ "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
+ "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
+ "customerCreationTime": "A String", # The customer's creation time (Readonly)
+ "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
+ "etag": "A String", # ETag of the resource.
+ "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
+ "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
+ "organizationName": "A String", # The company or company division name.
+ "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
+ "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
+ "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
+ "addressLine2": "A String", # Address line 2 of the address.
+ "addressLine3": "A String", # Address line 3 of the address.
+ "contactName": "A String", # The customer contact's name.
+ "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
+ "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
+ },
+ "id": "A String", # The unique ID for the customer's Google account. (Readonly)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(customerKey, body)</code>
+ <pre>Updates a customer. This method supports patch semantics.
+
+Args:
+ customerKey: string, Id of the customer to be updated (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Customer Resource object in Directory API.
+ "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
+ "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
+ "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
+ "customerCreationTime": "A String", # The customer's creation time (Readonly)
+ "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
+ "etag": "A String", # ETag of the resource.
+ "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
+ "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
+ "organizationName": "A String", # The company or company division name.
+ "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
+ "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
+ "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
+ "addressLine2": "A String", # Address line 2 of the address.
+ "addressLine3": "A String", # Address line 3 of the address.
+ "contactName": "A String", # The customer contact's name.
+ "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
+ "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
+ },
+ "id": "A String", # The unique ID for the customer's Google account. (Readonly)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Customer Resource object in Directory API.
+ "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
+ "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
+ "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
+ "customerCreationTime": "A String", # The customer's creation time (Readonly)
+ "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
+ "etag": "A String", # ETag of the resource.
+ "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
+ "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
+ "organizationName": "A String", # The company or company division name.
+ "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
+ "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
+ "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
+ "addressLine2": "A String", # Address line 2 of the address.
+ "addressLine3": "A String", # Address line 3 of the address.
+ "contactName": "A String", # The customer contact's name.
+ "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
+ "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
+ },
+ "id": "A String", # The unique ID for the customer's Google account. (Readonly)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(customerKey, body)</code>
+ <pre>Updates a customer.
+
+Args:
+ customerKey: string, Id of the customer to be updated (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Customer Resource object in Directory API.
+ "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
+ "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
+ "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
+ "customerCreationTime": "A String", # The customer's creation time (Readonly)
+ "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
+ "etag": "A String", # ETag of the resource.
+ "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
+ "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
+ "organizationName": "A String", # The company or company division name.
+ "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
+ "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
+ "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
+ "addressLine2": "A String", # Address line 2 of the address.
+ "addressLine3": "A String", # Address line 3 of the address.
+ "contactName": "A String", # The customer contact's name.
+ "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
+ "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
+ },
+ "id": "A String", # The unique ID for the customer's Google account. (Readonly)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Customer Resource object in Directory API.
+ "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
+ "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
+ "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
+ "customerCreationTime": "A String", # The customer's creation time (Readonly)
+ "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
+ "etag": "A String", # ETag of the resource.
+ "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
+ "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
+ "organizationName": "A String", # The company or company division name.
+ "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
+ "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
+ "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
+ "addressLine2": "A String", # Address line 2 of the address.
+ "addressLine3": "A String", # Address line 3 of the address.
+ "contactName": "A String", # The customer contact's name.
+ "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
+ "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
+ },
+ "id": "A String", # The unique ID for the customer's Google account. (Readonly)
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.domainAliases.html b/docs/dyn/admin_directory_v1.domainAliases.html
new file mode 100644
index 0000000..2d68567
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.domainAliases.html
@@ -0,0 +1,180 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.domainAliases.html">domainAliases</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(customer, domainAliasName)</a></code></p>
+<p class="firstline">Deletes a Domain Alias of the customer.</p>
+<p class="toc_element">
+ <code><a href="#get">get(customer, domainAliasName)</a></code></p>
+<p class="firstline">Retrieves a domain alias of the customer.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(customer, body)</a></code></p>
+<p class="firstline">Inserts a Domain alias of the customer.</p>
+<p class="toc_element">
+ <code><a href="#list">list(customer, parentDomainName=None)</a></code></p>
+<p class="firstline">Lists the domain aliases of the customer.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(customer, domainAliasName)</code>
+ <pre>Deletes a Domain Alias of the customer.
+
+Args:
+ customer: string, Immutable id of the Google Apps account. (required)
+ domainAliasName: string, Name of domain alias to be retrieved. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(customer, domainAliasName)</code>
+ <pre>Retrieves a domain alias of the customer.
+
+Args:
+ customer: string, Immutable id of the Google Apps account. (required)
+ domainAliasName: string, Name of domain alias to be retrieved. (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Domain Alias object in Directory API.
+ "kind": "admin#directory#domainAlias", # Kind of resource this is.
+ "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
+ "creationTime": "A String", # The creation time of the domain alias. (Read-only).
+ "etag": "A String", # ETag of the resource.
+ "domainAliasName": "A String", # The domain alias name.
+ "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(customer, body)</code>
+ <pre>Inserts a Domain alias of the customer.
+
+Args:
+ customer: string, Immutable id of the Google Apps account. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Domain Alias object in Directory API.
+ "kind": "admin#directory#domainAlias", # Kind of resource this is.
+ "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
+ "creationTime": "A String", # The creation time of the domain alias. (Read-only).
+ "etag": "A String", # ETag of the resource.
+ "domainAliasName": "A String", # The domain alias name.
+ "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Domain Alias object in Directory API.
+ "kind": "admin#directory#domainAlias", # Kind of resource this is.
+ "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
+ "creationTime": "A String", # The creation time of the domain alias. (Read-only).
+ "etag": "A String", # ETag of the resource.
+ "domainAliasName": "A String", # The domain alias name.
+ "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(customer, parentDomainName=None)</code>
+ <pre>Lists the domain aliases of the customer.
+
+Args:
+ customer: string, Immutable id of the Google Apps account. (required)
+ parentDomainName: string, Name of the parent domain for which domain aliases are to be fetched.
+
+Returns:
+ An object of the form:
+
+ { # JSON response template to list domain aliases in Directory API.
+ "domainAliases": [ # List of domain alias objects.
+ { # JSON template for Domain Alias object in Directory API.
+ "kind": "admin#directory#domainAlias", # Kind of resource this is.
+ "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
+ "creationTime": "A String", # The creation time of the domain alias. (Read-only).
+ "etag": "A String", # ETag of the resource.
+ "domainAliasName": "A String", # The domain alias name.
+ "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
+ },
+ ],
+ "kind": "admin#directory#domainAliases", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.domains.html b/docs/dyn/admin_directory_v1.domains.html
new file mode 100644
index 0000000..2939b48
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.domains.html
@@ -0,0 +1,219 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.domains.html">domains</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(customer, domainName)</a></code></p>
+<p class="firstline">Deletes a domain of the customer.</p>
+<p class="toc_element">
+ <code><a href="#get">get(customer, domainName)</a></code></p>
+<p class="firstline">Retrieves a domain of the customer.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(customer, body)</a></code></p>
+<p class="firstline">Inserts a domain of the customer.</p>
+<p class="toc_element">
+ <code><a href="#list">list(customer)</a></code></p>
+<p class="firstline">Lists the domains of the customer.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(customer, domainName)</code>
+ <pre>Deletes a domain of the customer.
+
+Args:
+ customer: string, Immutable id of the Google Apps account. (required)
+ domainName: string, Name of domain to be deleted (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(customer, domainName)</code>
+ <pre>Retrieves a domain of the customer.
+
+Args:
+ customer: string, Immutable id of the Google Apps account. (required)
+ domainName: string, Name of domain to be retrieved (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Domain object in Directory API.
+ "kind": "admin#directory#domain", # Kind of resource this is.
+ "verified": True or False, # Indicates the verification state of a domain. (Read-only).
+ "domainName": "A String", # The domain name of the customer.
+ "creationTime": "A String", # Creation time of the domain. (Read-only).
+ "etag": "A String", # ETag of the resource.
+ "domainAliases": [ # List of domain alias objects. (Read-only)
+ { # JSON template for Domain Alias object in Directory API.
+ "kind": "admin#directory#domainAlias", # Kind of resource this is.
+ "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
+ "creationTime": "A String", # The creation time of the domain alias. (Read-only).
+ "etag": "A String", # ETag of the resource.
+ "domainAliasName": "A String", # The domain alias name.
+ "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
+ },
+ ],
+ "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only).
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(customer, body)</code>
+ <pre>Inserts a domain of the customer.
+
+Args:
+ customer: string, Immutable id of the Google Apps account. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Domain object in Directory API.
+ "kind": "admin#directory#domain", # Kind of resource this is.
+ "verified": True or False, # Indicates the verification state of a domain. (Read-only).
+ "domainName": "A String", # The domain name of the customer.
+ "creationTime": "A String", # Creation time of the domain. (Read-only).
+ "etag": "A String", # ETag of the resource.
+ "domainAliases": [ # List of domain alias objects. (Read-only)
+ { # JSON template for Domain Alias object in Directory API.
+ "kind": "admin#directory#domainAlias", # Kind of resource this is.
+ "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
+ "creationTime": "A String", # The creation time of the domain alias. (Read-only).
+ "etag": "A String", # ETag of the resource.
+ "domainAliasName": "A String", # The domain alias name.
+ "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
+ },
+ ],
+ "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only).
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Domain object in Directory API.
+ "kind": "admin#directory#domain", # Kind of resource this is.
+ "verified": True or False, # Indicates the verification state of a domain. (Read-only).
+ "domainName": "A String", # The domain name of the customer.
+ "creationTime": "A String", # Creation time of the domain. (Read-only).
+ "etag": "A String", # ETag of the resource.
+ "domainAliases": [ # List of domain alias objects. (Read-only)
+ { # JSON template for Domain Alias object in Directory API.
+ "kind": "admin#directory#domainAlias", # Kind of resource this is.
+ "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
+ "creationTime": "A String", # The creation time of the domain alias. (Read-only).
+ "etag": "A String", # ETag of the resource.
+ "domainAliasName": "A String", # The domain alias name.
+ "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
+ },
+ ],
+ "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only).
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(customer)</code>
+ <pre>Lists the domains of the customer.
+
+Args:
+ customer: string, Immutable id of the Google Apps account. (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON response template to list Domains in Directory API.
+ "domains": [ # List of domain objects.
+ { # JSON template for Domain object in Directory API.
+ "kind": "admin#directory#domain", # Kind of resource this is.
+ "verified": True or False, # Indicates the verification state of a domain. (Read-only).
+ "domainName": "A String", # The domain name of the customer.
+ "creationTime": "A String", # Creation time of the domain. (Read-only).
+ "etag": "A String", # ETag of the resource.
+ "domainAliases": [ # List of domain alias objects. (Read-only)
+ { # JSON template for Domain Alias object in Directory API.
+ "kind": "admin#directory#domainAlias", # Kind of resource this is.
+ "verified": True or False, # Indicates the verification state of a domain alias. (Read-only)
+ "creationTime": "A String", # The creation time of the domain alias. (Read-only).
+ "etag": "A String", # ETag of the resource.
+ "domainAliasName": "A String", # The domain alias name.
+ "parentDomainName": "A String", # The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
+ },
+ ],
+ "isPrimary": True or False, # Indicates if the domain is a primary domain (Read-only).
+ },
+ ],
+ "kind": "admin#directory#domains", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.groups.aliases.html b/docs/dyn/admin_directory_v1.groups.aliases.html
new file mode 100644
index 0000000..4766717
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.groups.aliases.html
@@ -0,0 +1,146 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.groups.html">groups</a> . <a href="admin_directory_v1.groups.aliases.html">aliases</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(groupKey, alias)</a></code></p>
+<p class="firstline">Remove a alias for the group</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(groupKey, body)</a></code></p>
+<p class="firstline">Add a alias for the group</p>
+<p class="toc_element">
+ <code><a href="#list">list(groupKey)</a></code></p>
+<p class="firstline">List all aliases for a group</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(groupKey, alias)</code>
+ <pre>Remove a alias for the group
+
+Args:
+ groupKey: string, Email or immutable Id of the group (required)
+ alias: string, The alias to be removed (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(groupKey, body)</code>
+ <pre>Add a alias for the group
+
+Args:
+ groupKey: string, Email or immutable Id of the group (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Alias object in Directory API.
+ "alias": "A String", # A alias email
+ "kind": "admin#directory#alias", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
+ "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Alias object in Directory API.
+ "alias": "A String", # A alias email
+ "kind": "admin#directory#alias", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
+ "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(groupKey)</code>
+ <pre>List all aliases for a group
+
+Args:
+ groupKey: string, Email or immutable Id of the group (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON response template to list aliases in Directory API.
+ "kind": "admin#directory#aliases", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "aliases": [ # List of alias objects.
+ "",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.groups.html b/docs/dyn/admin_directory_v1.groups.html
new file mode 100644
index 0000000..feb0848
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.groups.html
@@ -0,0 +1,337 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.groups.html">groups</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="admin_directory_v1.groups.aliases.html">aliases()</a></code>
+</p>
+<p class="firstline">Returns the aliases Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#delete">delete(groupKey)</a></code></p>
+<p class="firstline">Delete Group</p>
+<p class="toc_element">
+ <code><a href="#get">get(groupKey)</a></code></p>
+<p class="firstline">Retrieve Group</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(body)</a></code></p>
+<p class="firstline">Create Group</p>
+<p class="toc_element">
+ <code><a href="#list">list(customer=None, domain=None, pageToken=None, maxResults=None, userKey=None)</a></code></p>
+<p class="firstline">Retrieve all groups in a domain (paginated)</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(groupKey, body)</a></code></p>
+<p class="firstline">Update Group. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(groupKey, body)</a></code></p>
+<p class="firstline">Update Group</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(groupKey)</code>
+ <pre>Delete Group
+
+Args:
+ groupKey: string, Email or immutable Id of the group (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(groupKey)</code>
+ <pre>Retrieve Group
+
+Args:
+ groupKey: string, Email or immutable Id of the group (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Group resource in Directory API.
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "kind": "admin#directory#group", # Kind of resource this is.
+ "description": "A String", # Description of the group
+ "name": "A String", # Group name
+ "adminCreated": True or False, # Is the group created by admin (Read-only) *
+ "directMembersCount": "A String", # Group direct members count
+ "id": "A String", # Unique identifier of Group (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "email": "A String", # Email of Group
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(body)</code>
+ <pre>Create Group
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Group resource in Directory API.
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "kind": "admin#directory#group", # Kind of resource this is.
+ "description": "A String", # Description of the group
+ "name": "A String", # Group name
+ "adminCreated": True or False, # Is the group created by admin (Read-only) *
+ "directMembersCount": "A String", # Group direct members count
+ "id": "A String", # Unique identifier of Group (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "email": "A String", # Email of Group
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Group resource in Directory API.
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "kind": "admin#directory#group", # Kind of resource this is.
+ "description": "A String", # Description of the group
+ "name": "A String", # Group name
+ "adminCreated": True or False, # Is the group created by admin (Read-only) *
+ "directMembersCount": "A String", # Group direct members count
+ "id": "A String", # Unique identifier of Group (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "email": "A String", # Email of Group
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(customer=None, domain=None, pageToken=None, maxResults=None, userKey=None)</code>
+ <pre>Retrieve all groups in a domain (paginated)
+
+Args:
+ customer: string, Immutable id of the Google Apps account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.
+ domain: string, Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.
+ pageToken: string, Token to specify next page in the list
+ maxResults: integer, Maximum number of results to return. Default is 200
+ userKey: string, Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object
+
+Returns:
+ An object of the form:
+
+ { # JSON response template for List Groups operation in Directory API.
+ "nextPageToken": "A String", # Token used to access next page of this result.
+ "kind": "admin#directory#groups", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "groups": [ # List of group objects.
+ { # JSON template for Group resource in Directory API.
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "kind": "admin#directory#group", # Kind of resource this is.
+ "description": "A String", # Description of the group
+ "name": "A String", # Group name
+ "adminCreated": True or False, # Is the group created by admin (Read-only) *
+ "directMembersCount": "A String", # Group direct members count
+ "id": "A String", # Unique identifier of Group (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "email": "A String", # Email of Group
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ },
+ ],
+ }</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(groupKey, body)</code>
+ <pre>Update Group. This method supports patch semantics.
+
+Args:
+ groupKey: string, Email or immutable Id of the group. If Id, it should match with id of group object (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Group resource in Directory API.
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "kind": "admin#directory#group", # Kind of resource this is.
+ "description": "A String", # Description of the group
+ "name": "A String", # Group name
+ "adminCreated": True or False, # Is the group created by admin (Read-only) *
+ "directMembersCount": "A String", # Group direct members count
+ "id": "A String", # Unique identifier of Group (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "email": "A String", # Email of Group
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Group resource in Directory API.
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "kind": "admin#directory#group", # Kind of resource this is.
+ "description": "A String", # Description of the group
+ "name": "A String", # Group name
+ "adminCreated": True or False, # Is the group created by admin (Read-only) *
+ "directMembersCount": "A String", # Group direct members count
+ "id": "A String", # Unique identifier of Group (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "email": "A String", # Email of Group
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(groupKey, body)</code>
+ <pre>Update Group
+
+Args:
+ groupKey: string, Email or immutable Id of the group. If Id, it should match with id of group object (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Group resource in Directory API.
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "kind": "admin#directory#group", # Kind of resource this is.
+ "description": "A String", # Description of the group
+ "name": "A String", # Group name
+ "adminCreated": True or False, # Is the group created by admin (Read-only) *
+ "directMembersCount": "A String", # Group direct members count
+ "id": "A String", # Unique identifier of Group (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "email": "A String", # Email of Group
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Group resource in Directory API.
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "kind": "admin#directory#group", # Kind of resource this is.
+ "description": "A String", # Description of the group
+ "name": "A String", # Group name
+ "adminCreated": True or False, # Is the group created by admin (Read-only) *
+ "directMembersCount": "A String", # Group direct members count
+ "id": "A String", # Unique identifier of Group (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "email": "A String", # Email of Group
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.html b/docs/dyn/admin_directory_v1.html
new file mode 100644
index 0000000..0ee0e76
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.html
@@ -0,0 +1,193 @@
+<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_directory_v1.html">Admin Directory API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="admin_directory_v1.asps.html">asps()</a></code>
+</p>
+<p class="firstline">Returns the asps Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.channels.html">channels()</a></code>
+</p>
+<p class="firstline">Returns the channels Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.chromeosdevices.html">chromeosdevices()</a></code>
+</p>
+<p class="firstline">Returns the chromeosdevices Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.customers.html">customers()</a></code>
+</p>
+<p class="firstline">Returns the customers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.domainAliases.html">domainAliases()</a></code>
+</p>
+<p class="firstline">Returns the domainAliases Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.domains.html">domains()</a></code>
+</p>
+<p class="firstline">Returns the domains Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.groups.html">groups()</a></code>
+</p>
+<p class="firstline">Returns the groups Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.members.html">members()</a></code>
+</p>
+<p class="firstline">Returns the members Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.mobiledevices.html">mobiledevices()</a></code>
+</p>
+<p class="firstline">Returns the mobiledevices Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.notifications.html">notifications()</a></code>
+</p>
+<p class="firstline">Returns the notifications Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.orgunits.html">orgunits()</a></code>
+</p>
+<p class="firstline">Returns the orgunits Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.privileges.html">privileges()</a></code>
+</p>
+<p class="firstline">Returns the privileges Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.resources.html">resources()</a></code>
+</p>
+<p class="firstline">Returns the resources Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.roleAssignments.html">roleAssignments()</a></code>
+</p>
+<p class="firstline">Returns the roleAssignments Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.roles.html">roles()</a></code>
+</p>
+<p class="firstline">Returns the roles Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.schemas.html">schemas()</a></code>
+</p>
+<p class="firstline">Returns the schemas Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.tokens.html">tokens()</a></code>
+</p>
+<p class="firstline">Returns the tokens Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.users.html">users()</a></code>
+</p>
+<p class="firstline">Returns the users Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.verificationCodes.html">verificationCodes()</a></code>
+</p>
+<p class="firstline">Returns the verificationCodes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.members.html b/docs/dyn/admin_directory_v1.members.html
new file mode 100644
index 0000000..b09b867
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.members.html
@@ -0,0 +1,280 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.members.html">members</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(groupKey, memberKey)</a></code></p>
+<p class="firstline">Remove membership.</p>
+<p class="toc_element">
+ <code><a href="#get">get(groupKey, memberKey)</a></code></p>
+<p class="firstline">Retrieve Group Member</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(groupKey, body)</a></code></p>
+<p class="firstline">Add user to the specified group.</p>
+<p class="toc_element">
+ <code><a href="#list">list(groupKey, pageToken=None, maxResults=None, roles=None)</a></code></p>
+<p class="firstline">Retrieve all members in a group (paginated)</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(groupKey, memberKey, body)</a></code></p>
+<p class="firstline">Update membership of a user in the specified group. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(groupKey, memberKey, body)</a></code></p>
+<p class="firstline">Update membership of a user in the specified group.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(groupKey, memberKey)</code>
+ <pre>Remove membership.
+
+Args:
+ groupKey: string, Email or immutable Id of the group (required)
+ memberKey: string, Email or immutable Id of the member (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(groupKey, memberKey)</code>
+ <pre>Retrieve Group Member
+
+Args:
+ groupKey: string, Email or immutable Id of the group (required)
+ memberKey: string, Email or immutable Id of the member (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Member resource in Directory API.
+ "status": "A String", # Status of member (Immutable)
+ "kind": "admin#directory#member", # Kind of resource this is.
+ "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "role": "A String", # Role of member
+ "type": "A String", # Type of member (Immutable)
+ "email": "A String", # Email of member (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(groupKey, body)</code>
+ <pre>Add user to the specified group.
+
+Args:
+ groupKey: string, Email or immutable Id of the group (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Member resource in Directory API.
+ "status": "A String", # Status of member (Immutable)
+ "kind": "admin#directory#member", # Kind of resource this is.
+ "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "role": "A String", # Role of member
+ "type": "A String", # Type of member (Immutable)
+ "email": "A String", # Email of member (Read-only)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Member resource in Directory API.
+ "status": "A String", # Status of member (Immutable)
+ "kind": "admin#directory#member", # Kind of resource this is.
+ "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "role": "A String", # Role of member
+ "type": "A String", # Type of member (Immutable)
+ "email": "A String", # Email of member (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(groupKey, pageToken=None, maxResults=None, roles=None)</code>
+ <pre>Retrieve all members in a group (paginated)
+
+Args:
+ groupKey: string, Email or immutable Id of the group (required)
+ pageToken: string, Token to specify next page in the list
+ maxResults: integer, Maximum number of results to return. Default is 200
+ roles: string, Comma separated role values to filter list results on.
+
+Returns:
+ An object of the form:
+
+ { # JSON response template for List Members operation in Directory API.
+ "nextPageToken": "A String", # Token used to access next page of this result.
+ "kind": "admin#directory#members", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "members": [ # List of member objects.
+ { # JSON template for Member resource in Directory API.
+ "status": "A String", # Status of member (Immutable)
+ "kind": "admin#directory#member", # Kind of resource this is.
+ "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "role": "A String", # Role of member
+ "type": "A String", # Type of member (Immutable)
+ "email": "A String", # Email of member (Read-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(groupKey, memberKey, body)</code>
+ <pre>Update membership of a user in the specified group. This method supports patch semantics.
+
+Args:
+ groupKey: string, Email or immutable Id of the group. If Id, it should match with id of group object (required)
+ memberKey: string, Email or immutable Id of the user. If Id, it should match with id of member object (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Member resource in Directory API.
+ "status": "A String", # Status of member (Immutable)
+ "kind": "admin#directory#member", # Kind of resource this is.
+ "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "role": "A String", # Role of member
+ "type": "A String", # Type of member (Immutable)
+ "email": "A String", # Email of member (Read-only)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Member resource in Directory API.
+ "status": "A String", # Status of member (Immutable)
+ "kind": "admin#directory#member", # Kind of resource this is.
+ "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "role": "A String", # Role of member
+ "type": "A String", # Type of member (Immutable)
+ "email": "A String", # Email of member (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(groupKey, memberKey, body)</code>
+ <pre>Update membership of a user in the specified group.
+
+Args:
+ groupKey: string, Email or immutable Id of the group. If Id, it should match with id of group object (required)
+ memberKey: string, Email or immutable Id of the user. If Id, it should match with id of member object (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Member resource in Directory API.
+ "status": "A String", # Status of member (Immutable)
+ "kind": "admin#directory#member", # Kind of resource this is.
+ "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "role": "A String", # Role of member
+ "type": "A String", # Type of member (Immutable)
+ "email": "A String", # Email of member (Read-only)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Member resource in Directory API.
+ "status": "A String", # Status of member (Immutable)
+ "kind": "admin#directory#member", # Kind of resource this is.
+ "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "role": "A String", # Role of member
+ "type": "A String", # Type of member (Immutable)
+ "email": "A String", # Email of member (Read-only)
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.mobiledevices.html b/docs/dyn/admin_directory_v1.mobiledevices.html
new file mode 100644
index 0000000..6809e8d
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.mobiledevices.html
@@ -0,0 +1,307 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.mobiledevices.html">mobiledevices</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#action">action(customerId, resourceId, body)</a></code></p>
+<p class="firstline">Take action on Mobile Device</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(customerId, resourceId)</a></code></p>
+<p class="firstline">Delete Mobile Device</p>
+<p class="toc_element">
+ <code><a href="#get">get(customerId, resourceId, projection=None)</a></code></p>
+<p class="firstline">Retrieve Mobile Device</p>
+<p class="toc_element">
+ <code><a href="#list">list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None)</a></code></p>
+<p class="firstline">Retrieve all Mobile Devices of a customer (paginated)</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="action">action(customerId, resourceId, body)</code>
+ <pre>Take action on Mobile Device
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ resourceId: string, Immutable id of Mobile Device (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON request template for firing commands on Mobile Device in Directory Devices API.
+ "action": "A String", # Action to be taken on the Mobile Device
+ }
+
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(customerId, resourceId)</code>
+ <pre>Delete Mobile Device
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ resourceId: string, Immutable id of Mobile Device (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(customerId, resourceId, projection=None)</code>
+ <pre>Retrieve Mobile Device
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ resourceId: string, Immutable id of Mobile Device (required)
+ projection: string, Restrict information returned to a set of selected fields.
+ Allowed values
+ BASIC - Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)
+ FULL - Includes all metadata fields
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Mobile Device resource in Directory API.
+ "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
+ "deviceCompromisedStatus": "A String", # Mobile Device compromised status (Read-only)
+ "resourceId": "A String", # Unique identifier of Mobile Device (Read-only)
+ "defaultLanguage": "A String", # The default locale used on the Mobile Device (Read-only)
+ "hardware": "A String", # Mobile Device Hardware (Read-only)
+ "userAgent": "A String", # Mobile Device user agent
+ "firstSync": "A String", # Date and time the device was first synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
+ "otherAccountsInfo": [ # List of accounts added on device (Read-only)
+ "A String",
+ ],
+ "releaseVersion": "A String", # Mobile Device release version version (Read-only)
+ "hardwareId": "A String", # Mobile Device Hardware Id (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "securityPatchLevel": "A String", # Mobile Device Security patch level (Read-only)
+ "privilege": "A String", # DMAgentPermission (Read-only)
+ "encryptionStatus": "A String", # Mobile Device Encryption Status (Read-only)
+ "type": "A String", # The type of device (Read-only)
+ "email": [ # List of owner user's email addresses (Read-only)
+ "A String",
+ ],
+ "devicePasswordStatus": "A String", # DevicePasswordStatus (Read-only)
+ "kernelVersion": "A String", # Mobile Device Kernel version (Read-only)
+ "brand": "A String", # Mobile Device Brand (Read-only)
+ "meid": "A String", # Mobile Device MEID number (Read-only)
+ "buildNumber": "A String", # Mobile Device Build number (Read-only)
+ "applications": [ # List of applications installed on Mobile Device
+ {
+ "versionCode": 42, # Version code of application
+ "packageName": "A String", # Package name of application
+ "displayName": "A String", # Display name of application
+ "versionName": "A String", # Version name of application
+ "permission": [ # List of Permissions for application
+ "A String",
+ ],
+ },
+ ],
+ "deviceId": "A String", # Mobile Device serial number (Read-only)
+ "imei": "A String", # Mobile Device IMEI number (Read-only)
+ "adbStatus": True or False, # Adb (USB debugging) enabled or disabled on device (Read-only)
+ "bootloaderVersion": "A String", # Mobile Device Bootloader version (Read-only)
+ "manufacturer": "A String", # Mobile Device manufacturer (Read-only)
+ "basebandVersion": "A String", # Mobile Device Baseband version (Read-only)
+ "kind": "admin#directory#mobiledevice", # Kind of resource this is.
+ "developerOptionsStatus": True or False, # Developer options enabled or disabled on device (Read-only)
+ "name": [ # List of owner user's names (Read-only)
+ "A String",
+ ],
+ "serialNumber": "A String", # Mobile Device SSN or Serial Number (Read-only)
+ "supportsWorkProfile": True or False, # Work profile supported on device (Read-only)
+ "networkOperator": "A String", # Mobile Device mobile or network operator (if available) (Read-only)
+ "status": "A String", # Status of the device (Read-only)
+ "unknownSourcesStatus": True or False, # Unknown sources enabled or disabled on device (Read-only)
+ "managedAccountIsOnOwnerProfile": True or False, # Boolean indicating if this account is on owner/primary profile or not (Read-only)
+ "model": "A String", # Name of the model of the device
+ "os": "A String", # Name of the mobile operating system
+ "wifiMacAddress": "A String", # Mobile Device WiFi MAC address (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None)</code>
+ <pre>Retrieve all Mobile Devices of a customer (paginated)
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ orderBy: string, Column to use for sorting results
+ Allowed values
+ deviceId - Mobile Device serial number.
+ email - Owner user email.
+ lastSync - Last policy settings sync date time of the device.
+ model - Mobile Device model.
+ name - Owner user name.
+ os - Mobile operating system.
+ status - Status of the device.
+ type - Type of the device.
+ projection: string, Restrict information returned to a set of selected fields.
+ Allowed values
+ BASIC - Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)
+ FULL - Includes all metadata fields
+ pageToken: string, Token to specify next page in the list
+ maxResults: integer, Maximum number of results to return. Default is 100
+ sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used
+ Allowed values
+ ASCENDING - Ascending order.
+ DESCENDING - Descending order.
+ query: string, Search string in the format given at http://support.google.com/a/bin/answer.py?hl=en&answer=1408863#search
+
+Returns:
+ An object of the form:
+
+ { # JSON response template for List Mobile Devices operation in Directory API.
+ "nextPageToken": "A String", # Token used to access next page of this result.
+ "kind": "admin#directory#mobiledevices", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "mobiledevices": [ # List of Mobile Device objects.
+ { # JSON template for Mobile Device resource in Directory API.
+ "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
+ "deviceCompromisedStatus": "A String", # Mobile Device compromised status (Read-only)
+ "resourceId": "A String", # Unique identifier of Mobile Device (Read-only)
+ "defaultLanguage": "A String", # The default locale used on the Mobile Device (Read-only)
+ "hardware": "A String", # Mobile Device Hardware (Read-only)
+ "userAgent": "A String", # Mobile Device user agent
+ "firstSync": "A String", # Date and time the device was first synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
+ "otherAccountsInfo": [ # List of accounts added on device (Read-only)
+ "A String",
+ ],
+ "releaseVersion": "A String", # Mobile Device release version version (Read-only)
+ "hardwareId": "A String", # Mobile Device Hardware Id (Read-only)
+ "etag": "A String", # ETag of the resource.
+ "securityPatchLevel": "A String", # Mobile Device Security patch level (Read-only)
+ "privilege": "A String", # DMAgentPermission (Read-only)
+ "encryptionStatus": "A String", # Mobile Device Encryption Status (Read-only)
+ "type": "A String", # The type of device (Read-only)
+ "email": [ # List of owner user's email addresses (Read-only)
+ "A String",
+ ],
+ "devicePasswordStatus": "A String", # DevicePasswordStatus (Read-only)
+ "kernelVersion": "A String", # Mobile Device Kernel version (Read-only)
+ "brand": "A String", # Mobile Device Brand (Read-only)
+ "meid": "A String", # Mobile Device MEID number (Read-only)
+ "buildNumber": "A String", # Mobile Device Build number (Read-only)
+ "applications": [ # List of applications installed on Mobile Device
+ {
+ "versionCode": 42, # Version code of application
+ "packageName": "A String", # Package name of application
+ "displayName": "A String", # Display name of application
+ "versionName": "A String", # Version name of application
+ "permission": [ # List of Permissions for application
+ "A String",
+ ],
+ },
+ ],
+ "deviceId": "A String", # Mobile Device serial number (Read-only)
+ "imei": "A String", # Mobile Device IMEI number (Read-only)
+ "adbStatus": True or False, # Adb (USB debugging) enabled or disabled on device (Read-only)
+ "bootloaderVersion": "A String", # Mobile Device Bootloader version (Read-only)
+ "manufacturer": "A String", # Mobile Device manufacturer (Read-only)
+ "basebandVersion": "A String", # Mobile Device Baseband version (Read-only)
+ "kind": "admin#directory#mobiledevice", # Kind of resource this is.
+ "developerOptionsStatus": True or False, # Developer options enabled or disabled on device (Read-only)
+ "name": [ # List of owner user's names (Read-only)
+ "A String",
+ ],
+ "serialNumber": "A String", # Mobile Device SSN or Serial Number (Read-only)
+ "supportsWorkProfile": True or False, # Work profile supported on device (Read-only)
+ "networkOperator": "A String", # Mobile Device mobile or network operator (if available) (Read-only)
+ "status": "A String", # Status of the device (Read-only)
+ "unknownSourcesStatus": True or False, # Unknown sources enabled or disabled on device (Read-only)
+ "managedAccountIsOnOwnerProfile": True or False, # Boolean indicating if this account is on owner/primary profile or not (Read-only)
+ "model": "A String", # Name of the model of the device
+ "os": "A String", # Name of the mobile operating system
+ "wifiMacAddress": "A String", # Mobile Device WiFi MAC address (Read-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>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.notifications.html b/docs/dyn/admin_directory_v1.notifications.html
new file mode 100644
index 0000000..dcd604f
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.notifications.html
@@ -0,0 +1,250 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.notifications.html">notifications</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(customer, notificationId)</a></code></p>
+<p class="firstline">Deletes a notification</p>
+<p class="toc_element">
+ <code><a href="#get">get(customer, notificationId)</a></code></p>
+<p class="firstline">Retrieves a notification.</p>
+<p class="toc_element">
+ <code><a href="#list">list(customer, language=None, pageToken=None, maxResults=None)</a></code></p>
+<p class="firstline">Retrieves a list of notifications.</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(customer, notificationId, body)</a></code></p>
+<p class="firstline">Updates a notification. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(customer, notificationId, body)</a></code></p>
+<p class="firstline">Updates a notification.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(customer, notificationId)</code>
+ <pre>Deletes a notification
+
+Args:
+ customer: string, The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource. (required)
+ notificationId: string, The unique ID of the notification. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(customer, notificationId)</code>
+ <pre>Retrieves a notification.
+
+Args:
+ customer: string, The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource. (required)
+ notificationId: string, The unique ID of the notification. (required)
+
+Returns:
+ An object of the form:
+
+ { # Template for a notification resource.
+ "body": "A String", # Body of the notification (Read-only)
+ "kind": "admin#directory#notification", # The type of the resource.
+ "etag": "A String", # ETag of the resource.
+ "sendTime": "A String", # Time at which notification was sent (Read-only)
+ "notificationId": "A String",
+ "fromAddress": "A String", # Address from which the notification is received (Read-only)
+ "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
+ "subject": "A String", # Subject of the notification (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(customer, language=None, pageToken=None, maxResults=None)</code>
+ <pre>Retrieves a list of notifications.
+
+Args:
+ customer: string, The unique ID for the customer's Google account. (required)
+ language: string, The ISO 639-1 code of the language notifications are returned in. The default is English (en).
+ pageToken: string, The token to specify the page of results to retrieve.
+ maxResults: integer, Maximum number of notifications to return per page. The default is 100.
+
+Returns:
+ An object of the form:
+
+ { # Template for notifications list response.
+ "nextPageToken": "A String", # Token for fetching the next page of notifications.
+ "items": [ # List of notifications in this page.
+ { # Template for a notification resource.
+ "body": "A String", # Body of the notification (Read-only)
+ "kind": "admin#directory#notification", # The type of the resource.
+ "etag": "A String", # ETag of the resource.
+ "sendTime": "A String", # Time at which notification was sent (Read-only)
+ "notificationId": "A String",
+ "fromAddress": "A String", # Address from which the notification is received (Read-only)
+ "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
+ "subject": "A String", # Subject of the notification (Read-only)
+ },
+ ],
+ "kind": "admin#directory#notifications", # The type of the resource.
+ "etag": "A String", # ETag of the resource.
+ "unreadNotificationsCount": 42, # Number of unread notification for the domain.
+ }</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(customer, notificationId, body)</code>
+ <pre>Updates a notification. This method supports patch semantics.
+
+Args:
+ customer: string, The unique ID for the customer's Google account. (required)
+ notificationId: string, The unique ID of the notification. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Template for a notification resource.
+ "body": "A String", # Body of the notification (Read-only)
+ "kind": "admin#directory#notification", # The type of the resource.
+ "etag": "A String", # ETag of the resource.
+ "sendTime": "A String", # Time at which notification was sent (Read-only)
+ "notificationId": "A String",
+ "fromAddress": "A String", # Address from which the notification is received (Read-only)
+ "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
+ "subject": "A String", # Subject of the notification (Read-only)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Template for a notification resource.
+ "body": "A String", # Body of the notification (Read-only)
+ "kind": "admin#directory#notification", # The type of the resource.
+ "etag": "A String", # ETag of the resource.
+ "sendTime": "A String", # Time at which notification was sent (Read-only)
+ "notificationId": "A String",
+ "fromAddress": "A String", # Address from which the notification is received (Read-only)
+ "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
+ "subject": "A String", # Subject of the notification (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(customer, notificationId, body)</code>
+ <pre>Updates a notification.
+
+Args:
+ customer: string, The unique ID for the customer's Google account. (required)
+ notificationId: string, The unique ID of the notification. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Template for a notification resource.
+ "body": "A String", # Body of the notification (Read-only)
+ "kind": "admin#directory#notification", # The type of the resource.
+ "etag": "A String", # ETag of the resource.
+ "sendTime": "A String", # Time at which notification was sent (Read-only)
+ "notificationId": "A String",
+ "fromAddress": "A String", # Address from which the notification is received (Read-only)
+ "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
+ "subject": "A String", # Subject of the notification (Read-only)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Template for a notification resource.
+ "body": "A String", # Body of the notification (Read-only)
+ "kind": "admin#directory#notification", # The type of the resource.
+ "etag": "A String", # ETag of the resource.
+ "sendTime": "A String", # Time at which notification was sent (Read-only)
+ "notificationId": "A String",
+ "fromAddress": "A String", # Address from which the notification is received (Read-only)
+ "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
+ "subject": "A String", # Subject of the notification (Read-only)
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.orgunits.html b/docs/dyn/admin_directory_v1.orgunits.html
new file mode 100644
index 0000000..e67e1ee
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.orgunits.html
@@ -0,0 +1,280 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.orgunits.html">orgunits</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(customerId, orgUnitPath)</a></code></p>
+<p class="firstline">Remove Organization Unit</p>
+<p class="toc_element">
+ <code><a href="#get">get(customerId, orgUnitPath)</a></code></p>
+<p class="firstline">Retrieve Organization Unit</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(customerId, body)</a></code></p>
+<p class="firstline">Add Organization Unit</p>
+<p class="toc_element">
+ <code><a href="#list">list(customerId, type=None, orgUnitPath=None)</a></code></p>
+<p class="firstline">Retrieve all Organization Units</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(customerId, orgUnitPath, body)</a></code></p>
+<p class="firstline">Update Organization Unit. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(customerId, orgUnitPath, body)</a></code></p>
+<p class="firstline">Update Organization Unit</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(customerId, orgUnitPath)</code>
+ <pre>Remove Organization Unit
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ orgUnitPath: string, Full path of the organization unit or its Id (required) (repeated)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(customerId, orgUnitPath)</code>
+ <pre>Retrieve Organization Unit
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ orgUnitPath: string, Full path of the organization unit or its Id (required) (repeated)
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Org Unit resource in Directory API.
+ "kind": "admin#directory#orgUnit", # Kind of resource this is.
+ "parentOrgUnitPath": "A String", # Path of parent OrgUnit
+ "name": "A String", # Name of OrgUnit
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # Path of OrgUnit
+ "parentOrgUnitId": "A String", # Id of parent OrgUnit
+ "blockInheritance": True or False, # Should block inheritance
+ "orgUnitId": "A String", # Id of OrgUnit
+ "description": "A String", # Description of OrgUnit
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(customerId, body)</code>
+ <pre>Add Organization Unit
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Org Unit resource in Directory API.
+ "kind": "admin#directory#orgUnit", # Kind of resource this is.
+ "parentOrgUnitPath": "A String", # Path of parent OrgUnit
+ "name": "A String", # Name of OrgUnit
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # Path of OrgUnit
+ "parentOrgUnitId": "A String", # Id of parent OrgUnit
+ "blockInheritance": True or False, # Should block inheritance
+ "orgUnitId": "A String", # Id of OrgUnit
+ "description": "A String", # Description of OrgUnit
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Org Unit resource in Directory API.
+ "kind": "admin#directory#orgUnit", # Kind of resource this is.
+ "parentOrgUnitPath": "A String", # Path of parent OrgUnit
+ "name": "A String", # Name of OrgUnit
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # Path of OrgUnit
+ "parentOrgUnitId": "A String", # Id of parent OrgUnit
+ "blockInheritance": True or False, # Should block inheritance
+ "orgUnitId": "A String", # Id of OrgUnit
+ "description": "A String", # Description of OrgUnit
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(customerId, type=None, orgUnitPath=None)</code>
+ <pre>Retrieve all Organization Units
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ type: string, Whether to return all sub-organizations or just immediate children
+ Allowed values
+ all - All sub-organization units.
+ children - Immediate children only (default).
+ orgUnitPath: string, the URL-encoded organization unit's path or its Id
+
+Returns:
+ An object of the form:
+
+ { # JSON response template for List Organization Units operation in Directory API.
+ "kind": "admin#directory#orgUnits", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "organizationUnits": [ # List of user objects.
+ { # JSON template for Org Unit resource in Directory API.
+ "kind": "admin#directory#orgUnit", # Kind of resource this is.
+ "parentOrgUnitPath": "A String", # Path of parent OrgUnit
+ "name": "A String", # Name of OrgUnit
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # Path of OrgUnit
+ "parentOrgUnitId": "A String", # Id of parent OrgUnit
+ "blockInheritance": True or False, # Should block inheritance
+ "orgUnitId": "A String", # Id of OrgUnit
+ "description": "A String", # Description of OrgUnit
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(customerId, orgUnitPath, body)</code>
+ <pre>Update Organization Unit. This method supports patch semantics.
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ orgUnitPath: string, Full path of the organization unit or its Id (required) (repeated)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Org Unit resource in Directory API.
+ "kind": "admin#directory#orgUnit", # Kind of resource this is.
+ "parentOrgUnitPath": "A String", # Path of parent OrgUnit
+ "name": "A String", # Name of OrgUnit
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # Path of OrgUnit
+ "parentOrgUnitId": "A String", # Id of parent OrgUnit
+ "blockInheritance": True or False, # Should block inheritance
+ "orgUnitId": "A String", # Id of OrgUnit
+ "description": "A String", # Description of OrgUnit
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Org Unit resource in Directory API.
+ "kind": "admin#directory#orgUnit", # Kind of resource this is.
+ "parentOrgUnitPath": "A String", # Path of parent OrgUnit
+ "name": "A String", # Name of OrgUnit
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # Path of OrgUnit
+ "parentOrgUnitId": "A String", # Id of parent OrgUnit
+ "blockInheritance": True or False, # Should block inheritance
+ "orgUnitId": "A String", # Id of OrgUnit
+ "description": "A String", # Description of OrgUnit
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(customerId, orgUnitPath, body)</code>
+ <pre>Update Organization Unit
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ orgUnitPath: string, Full path of the organization unit or its Id (required) (repeated)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Org Unit resource in Directory API.
+ "kind": "admin#directory#orgUnit", # Kind of resource this is.
+ "parentOrgUnitPath": "A String", # Path of parent OrgUnit
+ "name": "A String", # Name of OrgUnit
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # Path of OrgUnit
+ "parentOrgUnitId": "A String", # Id of parent OrgUnit
+ "blockInheritance": True or False, # Should block inheritance
+ "orgUnitId": "A String", # Id of OrgUnit
+ "description": "A String", # Description of OrgUnit
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Org Unit resource in Directory API.
+ "kind": "admin#directory#orgUnit", # Kind of resource this is.
+ "parentOrgUnitPath": "A String", # Path of parent OrgUnit
+ "name": "A String", # Name of OrgUnit
+ "etag": "A String", # ETag of the resource.
+ "orgUnitPath": "A String", # Path of OrgUnit
+ "parentOrgUnitId": "A String", # Id of parent OrgUnit
+ "blockInheritance": True or False, # Should block inheritance
+ "orgUnitId": "A String", # Id of OrgUnit
+ "description": "A String", # Description of OrgUnit
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.privileges.html b/docs/dyn/admin_directory_v1.privileges.html
new file mode 100644
index 0000000..37b931a
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.privileges.html
@@ -0,0 +1,110 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.privileges.html">privileges</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(customer)</a></code></p>
+<p class="firstline">Retrieves a paginated list of all privileges for a customer.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(customer)</code>
+ <pre>Retrieves a paginated list of all privileges for a customer.
+
+Args:
+ customer: string, Immutable ID of the Google Apps account. (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON response template for List privileges operation in Directory API.
+ "items": [ # A list of Privilege resources.
+ { # JSON template for privilege resource in Directory API.
+ "kind": "admin#directory#privilege", # The type of the API resource. This is always admin#directory#privilege.
+ "privilegeName": "A String", # The name of the privilege.
+ "isOuScopable": True or False, # If the privilege can be restricted to an organization unit.
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
+ "etag": "A String", # ETag of the resource.
+ "childPrivileges": [ # A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege.
+ # Object with schema name: Privilege
+ ],
+ "serviceName": "A String", # The name of the service this privilege is for.
+ },
+ ],
+ "kind": "admin#directory#privileges", # The type of the API resource. This is always admin#directory#privileges.
+ "etag": "A String", # ETag of the resource.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.resources.calendars.html b/docs/dyn/admin_directory_v1.resources.calendars.html
new file mode 100644
index 0000000..66fa23c
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.resources.calendars.html
@@ -0,0 +1,279 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.resources.html">resources</a> . <a href="admin_directory_v1.resources.calendars.html">calendars</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(customer, calendarResourceId)</a></code></p>
+<p class="firstline">Deletes a calendar resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(customer, calendarResourceId)</a></code></p>
+<p class="firstline">Retrieves a calendar resource.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(customer, body)</a></code></p>
+<p class="firstline">Inserts a calendar resource.</p>
+<p class="toc_element">
+ <code><a href="#list">list(customer, pageToken=None, maxResults=None)</a></code></p>
+<p class="firstline">Retrieves a list of calendar resources for an 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>
+<p class="toc_element">
+ <code><a href="#patch">patch(customer, calendarResourceId, body)</a></code></p>
+<p class="firstline">Updates a calendar resource. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(customer, calendarResourceId, body)</a></code></p>
+<p class="firstline">Updates a calendar resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(customer, calendarResourceId)</code>
+ <pre>Deletes a calendar resource.
+
+Args:
+ customer: string, The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
+ calendarResourceId: string, The unique ID of the calendar resource to delete. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(customer, calendarResourceId)</code>
+ <pre>Retrieves a calendar resource.
+
+Args:
+ customer: string, The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
+ calendarResourceId: string, The unique ID of the calendar resource to retrieve. (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Calendar Resource object in Directory API.
+ "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
+ "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
+ "resourceDescription": "A String", # The brief description of the calendar resource.
+ "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
+ "etags": "A String", # ETag of the resource.
+ "resourceId": "A String", # The unique ID for the calendar resource.
+ "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(customer, body)</code>
+ <pre>Inserts a calendar resource.
+
+Args:
+ customer: string, The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Calendar Resource object in Directory API.
+ "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
+ "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
+ "resourceDescription": "A String", # The brief description of the calendar resource.
+ "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
+ "etags": "A String", # ETag of the resource.
+ "resourceId": "A String", # The unique ID for the calendar resource.
+ "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Calendar Resource object in Directory API.
+ "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
+ "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
+ "resourceDescription": "A String", # The brief description of the calendar resource.
+ "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
+ "etags": "A String", # ETag of the resource.
+ "resourceId": "A String", # The unique ID for the calendar resource.
+ "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(customer, pageToken=None, maxResults=None)</code>
+ <pre>Retrieves a list of calendar resources for an account.
+
+Args:
+ customer: string, The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
+ pageToken: string, Token to specify the next page in the list.
+ maxResults: integer, Maximum number of results to return.
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Calendar Resource List Response object in Directory API.
+ "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "items": [ # The CalendarResources in this page of results.
+ { # JSON template for Calendar Resource object in Directory API.
+ "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
+ "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
+ "resourceDescription": "A String", # The brief description of the calendar resource.
+ "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
+ "etags": "A String", # ETag of the resource.
+ "resourceId": "A String", # The unique ID for the calendar resource.
+ "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
+ },
+ ],
+ "kind": "admin#directory#resources#calendars#calendarResourcesList", # Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList.
+ "etag": "A String", # ETag of the resource.
+ }</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(customer, calendarResourceId, body)</code>
+ <pre>Updates a calendar resource. This method supports patch semantics.
+
+Args:
+ customer: string, The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
+ calendarResourceId: string, The unique ID of the calendar resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Calendar Resource object in Directory API.
+ "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
+ "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
+ "resourceDescription": "A String", # The brief description of the calendar resource.
+ "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
+ "etags": "A String", # ETag of the resource.
+ "resourceId": "A String", # The unique ID for the calendar resource.
+ "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Calendar Resource object in Directory API.
+ "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
+ "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
+ "resourceDescription": "A String", # The brief description of the calendar resource.
+ "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
+ "etags": "A String", # ETag of the resource.
+ "resourceId": "A String", # The unique ID for the calendar resource.
+ "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(customer, calendarResourceId, body)</code>
+ <pre>Updates a calendar resource.
+
+Args:
+ customer: string, The unique ID for the customer's Google account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
+ calendarResourceId: string, The unique ID of the calendar resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Calendar Resource object in Directory API.
+ "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
+ "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
+ "resourceDescription": "A String", # The brief description of the calendar resource.
+ "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
+ "etags": "A String", # ETag of the resource.
+ "resourceId": "A String", # The unique ID for the calendar resource.
+ "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Calendar Resource object in Directory API.
+ "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
+ "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
+ "resourceDescription": "A String", # The brief description of the calendar resource.
+ "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
+ "etags": "A String", # ETag of the resource.
+ "resourceId": "A String", # The unique ID for the calendar resource.
+ "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dataflow_v1beta3.v1b3.html b/docs/dyn/admin_directory_v1.resources.html
similarity index 78%
copy from docs/dyn/dataflow_v1beta3.v1b3.html
copy to docs/dyn/admin_directory_v1.resources.html
index e81eb27..ccaaa78 100644
--- a/docs/dyn/dataflow_v1beta3.v1b3.html
+++ b/docs/dyn/admin_directory_v1.resources.html
@@ -72,11 +72,11 @@
</style>
-<h1><a href="dataflow_v1beta3.html">Google Dataflow API</a> . <a href="dataflow_v1beta3.v1b3.html">v1b3</a></h1>
+<h1><a href="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.resources.html">resources</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="dataflow_v1beta3.v1b3.projects.html">projects()</a></code>
+ <code><a href="admin_directory_v1.resources.calendars.html">calendars()</a></code>
</p>
-<p class="firstline">Returns the projects Resource.</p>
+<p class="firstline">Returns the calendars Resource.</p>
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.roleAssignments.html b/docs/dyn/admin_directory_v1.roleAssignments.html
new file mode 100644
index 0000000..5b3979d
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.roleAssignments.html
@@ -0,0 +1,213 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.roleAssignments.html">roleAssignments</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(customer, roleAssignmentId)</a></code></p>
+<p class="firstline">Deletes a role assignment.</p>
+<p class="toc_element">
+ <code><a href="#get">get(customer, roleAssignmentId)</a></code></p>
+<p class="firstline">Retrieve a role assignment.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(customer, body)</a></code></p>
+<p class="firstline">Creates a role assignment.</p>
+<p class="toc_element">
+ <code><a href="#list">list(customer, pageToken=None, roleId=None, maxResults=None, userKey=None)</a></code></p>
+<p class="firstline">Retrieves a paginated list of all roleAssignments.</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(customer, roleAssignmentId)</code>
+ <pre>Deletes a role assignment.
+
+Args:
+ customer: string, Immutable ID of the Google Apps account. (required)
+ roleAssignmentId: string, Immutable ID of the role assignment. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(customer, roleAssignmentId)</code>
+ <pre>Retrieve a role assignment.
+
+Args:
+ customer: string, Immutable ID of the Google Apps account. (required)
+ roleAssignmentId: string, Immutable ID of the role assignment. (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON template for roleAssignment resource in Directory API.
+ "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
+ "roleAssignmentId": "A String", # ID of this roleAssignment.
+ "roleId": "A String", # The ID of the role that is assigned.
+ "assignedTo": "A String", # The unique ID of the user this role is assigned to.
+ "etag": "A String", # ETag of the resource.
+ "scopeType": "A String", # The scope in which this role is assigned. Possible values are:
+ # - CUSTOMER
+ # - ORG_UNIT
+ "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(customer, body)</code>
+ <pre>Creates a role assignment.
+
+Args:
+ customer: string, Immutable ID of the Google Apps account. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for roleAssignment resource in Directory API.
+ "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
+ "roleAssignmentId": "A String", # ID of this roleAssignment.
+ "roleId": "A String", # The ID of the role that is assigned.
+ "assignedTo": "A String", # The unique ID of the user this role is assigned to.
+ "etag": "A String", # ETag of the resource.
+ "scopeType": "A String", # The scope in which this role is assigned. Possible values are:
+ # - CUSTOMER
+ # - ORG_UNIT
+ "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for roleAssignment resource in Directory API.
+ "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
+ "roleAssignmentId": "A String", # ID of this roleAssignment.
+ "roleId": "A String", # The ID of the role that is assigned.
+ "assignedTo": "A String", # The unique ID of the user this role is assigned to.
+ "etag": "A String", # ETag of the resource.
+ "scopeType": "A String", # The scope in which this role is assigned. Possible values are:
+ # - CUSTOMER
+ # - ORG_UNIT
+ "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(customer, pageToken=None, roleId=None, maxResults=None, userKey=None)</code>
+ <pre>Retrieves a paginated list of all roleAssignments.
+
+Args:
+ customer: string, Immutable ID of the Google Apps account. (required)
+ pageToken: string, Token to specify the next page in the list.
+ roleId: string, Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.
+ maxResults: integer, Maximum number of results to return.
+ userKey: string, The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user.
+
+Returns:
+ An object of the form:
+
+ { # JSON response template for List roleAssignments operation in Directory API.
+ "nextPageToken": "A String",
+ "items": [ # A list of RoleAssignment resources.
+ { # JSON template for roleAssignment resource in Directory API.
+ "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
+ "roleAssignmentId": "A String", # ID of this roleAssignment.
+ "roleId": "A String", # The ID of the role that is assigned.
+ "assignedTo": "A String", # The unique ID of the user this role is assigned to.
+ "etag": "A String", # ETag of the resource.
+ "scopeType": "A String", # The scope in which this role is assigned. Possible values are:
+ # - CUSTOMER
+ # - ORG_UNIT
+ "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
+ },
+ ],
+ "kind": "admin#directory#roleAssignments", # The type of the API resource. This is always admin#directory#roleAssignments.
+ "etag": "A String", # ETag of the resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.roles.html b/docs/dyn/admin_directory_v1.roles.html
new file mode 100644
index 0000000..9c74b4e
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.roles.html
@@ -0,0 +1,327 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.roles.html">roles</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(customer, roleId)</a></code></p>
+<p class="firstline">Deletes a role.</p>
+<p class="toc_element">
+ <code><a href="#get">get(customer, roleId)</a></code></p>
+<p class="firstline">Retrieves a role.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(customer, body)</a></code></p>
+<p class="firstline">Creates a role.</p>
+<p class="toc_element">
+ <code><a href="#list">list(customer, pageToken=None, maxResults=None)</a></code></p>
+<p class="firstline">Retrieves a paginated list of all the roles in a domain.</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(customer, roleId, body)</a></code></p>
+<p class="firstline">Updates a role. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(customer, roleId, body)</a></code></p>
+<p class="firstline">Updates a role.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(customer, roleId)</code>
+ <pre>Deletes a role.
+
+Args:
+ customer: string, Immutable ID of the Google Apps account. (required)
+ roleId: string, Immutable ID of the role. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(customer, roleId)</code>
+ <pre>Retrieves a role.
+
+Args:
+ customer: string, Immutable ID of the Google Apps account. (required)
+ roleId: string, Immutable ID of the role. (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON template for role resource in Directory API.
+ "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
+ "roleId": "A String", # ID of the role.
+ "roleDescription": "A String", # A short description of the role.
+ "etag": "A String", # ETag of the resource.
+ "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
+ "roleName": "A String", # Name of the role.
+ "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
+ "rolePrivileges": [ # The set of privileges that are granted to this role.
+ {
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
+ "privilegeName": "A String", # The name of the privilege.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(customer, body)</code>
+ <pre>Creates a role.
+
+Args:
+ customer: string, Immutable ID of the Google Apps account. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for role resource in Directory API.
+ "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
+ "roleId": "A String", # ID of the role.
+ "roleDescription": "A String", # A short description of the role.
+ "etag": "A String", # ETag of the resource.
+ "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
+ "roleName": "A String", # Name of the role.
+ "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
+ "rolePrivileges": [ # The set of privileges that are granted to this role.
+ {
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
+ "privilegeName": "A String", # The name of the privilege.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for role resource in Directory API.
+ "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
+ "roleId": "A String", # ID of the role.
+ "roleDescription": "A String", # A short description of the role.
+ "etag": "A String", # ETag of the resource.
+ "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
+ "roleName": "A String", # Name of the role.
+ "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
+ "rolePrivileges": [ # The set of privileges that are granted to this role.
+ {
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
+ "privilegeName": "A String", # The name of the privilege.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(customer, pageToken=None, maxResults=None)</code>
+ <pre>Retrieves a paginated list of all the roles in a domain.
+
+Args:
+ customer: string, Immutable id of the Google Apps account. (required)
+ pageToken: string, Token to specify the next page in the list.
+ maxResults: integer, Maximum number of results to return.
+
+Returns:
+ An object of the form:
+
+ { # JSON response template for List roles operation in Directory API.
+ "nextPageToken": "A String",
+ "items": [ # A list of Role resources.
+ { # JSON template for role resource in Directory API.
+ "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
+ "roleId": "A String", # ID of the role.
+ "roleDescription": "A String", # A short description of the role.
+ "etag": "A String", # ETag of the resource.
+ "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
+ "roleName": "A String", # Name of the role.
+ "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
+ "rolePrivileges": [ # The set of privileges that are granted to this role.
+ {
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
+ "privilegeName": "A String", # The name of the privilege.
+ },
+ ],
+ },
+ ],
+ "kind": "admin#directory#roles", # The type of the API resource. This is always admin#directory#roles.
+ "etag": "A String", # ETag of the resource.
+ }</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(customer, roleId, body)</code>
+ <pre>Updates a role. This method supports patch semantics.
+
+Args:
+ customer: string, Immutable ID of the Google Apps account. (required)
+ roleId: string, Immutable ID of the role. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for role resource in Directory API.
+ "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
+ "roleId": "A String", # ID of the role.
+ "roleDescription": "A String", # A short description of the role.
+ "etag": "A String", # ETag of the resource.
+ "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
+ "roleName": "A String", # Name of the role.
+ "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
+ "rolePrivileges": [ # The set of privileges that are granted to this role.
+ {
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
+ "privilegeName": "A String", # The name of the privilege.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for role resource in Directory API.
+ "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
+ "roleId": "A String", # ID of the role.
+ "roleDescription": "A String", # A short description of the role.
+ "etag": "A String", # ETag of the resource.
+ "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
+ "roleName": "A String", # Name of the role.
+ "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
+ "rolePrivileges": [ # The set of privileges that are granted to this role.
+ {
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
+ "privilegeName": "A String", # The name of the privilege.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(customer, roleId, body)</code>
+ <pre>Updates a role.
+
+Args:
+ customer: string, Immutable ID of the Google Apps account. (required)
+ roleId: string, Immutable ID of the role. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for role resource in Directory API.
+ "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
+ "roleId": "A String", # ID of the role.
+ "roleDescription": "A String", # A short description of the role.
+ "etag": "A String", # ETag of the resource.
+ "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
+ "roleName": "A String", # Name of the role.
+ "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
+ "rolePrivileges": [ # The set of privileges that are granted to this role.
+ {
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
+ "privilegeName": "A String", # The name of the privilege.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for role resource in Directory API.
+ "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
+ "roleId": "A String", # ID of the role.
+ "roleDescription": "A String", # A short description of the role.
+ "etag": "A String", # ETag of the resource.
+ "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
+ "roleName": "A String", # Name of the role.
+ "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
+ "rolePrivileges": [ # The set of privileges that are granted to this role.
+ {
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
+ "privilegeName": "A String", # The name of the privilege.
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.schemas.html b/docs/dyn/admin_directory_v1.schemas.html
new file mode 100644
index 0000000..c364283
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.schemas.html
@@ -0,0 +1,363 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.schemas.html">schemas</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(customerId, schemaKey)</a></code></p>
+<p class="firstline">Delete schema</p>
+<p class="toc_element">
+ <code><a href="#get">get(customerId, schemaKey)</a></code></p>
+<p class="firstline">Retrieve schema</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(customerId, body)</a></code></p>
+<p class="firstline">Create schema.</p>
+<p class="toc_element">
+ <code><a href="#list">list(customerId)</a></code></p>
+<p class="firstline">Retrieve all schemas for a customer</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(customerId, schemaKey, body)</a></code></p>
+<p class="firstline">Update schema. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(customerId, schemaKey, body)</a></code></p>
+<p class="firstline">Update schema</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(customerId, schemaKey)</code>
+ <pre>Delete schema
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ schemaKey: string, Name or immutable Id of the schema (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(customerId, schemaKey)</code>
+ <pre>Retrieve schema
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ schemaKey: string, Name or immutable Id of the schema (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Schema resource in Directory API.
+ "fields": [ # Fields of Schema
+ { # JSON template for FieldSpec resource for Schemas in Directory API.
+ "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "fieldName": "A String", # Name of the field.
+ "fieldType": "A String", # Type of the field.
+ "indexed": true, # Boolean specifying whether the field is indexed or not.
+ "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
+ "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
+ "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ },
+ "fieldId": "A String", # Unique identifier of Field (Read-only)
+ "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
+ },
+ ],
+ "kind": "admin#directory#schema", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "schemaId": "A String", # Unique identifier of Schema (Read-only)
+ "schemaName": "A String", # Schema name
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(customerId, body)</code>
+ <pre>Create schema.
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Schema resource in Directory API.
+ "fields": [ # Fields of Schema
+ { # JSON template for FieldSpec resource for Schemas in Directory API.
+ "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "fieldName": "A String", # Name of the field.
+ "fieldType": "A String", # Type of the field.
+ "indexed": true, # Boolean specifying whether the field is indexed or not.
+ "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
+ "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
+ "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ },
+ "fieldId": "A String", # Unique identifier of Field (Read-only)
+ "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
+ },
+ ],
+ "kind": "admin#directory#schema", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "schemaId": "A String", # Unique identifier of Schema (Read-only)
+ "schemaName": "A String", # Schema name
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Schema resource in Directory API.
+ "fields": [ # Fields of Schema
+ { # JSON template for FieldSpec resource for Schemas in Directory API.
+ "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "fieldName": "A String", # Name of the field.
+ "fieldType": "A String", # Type of the field.
+ "indexed": true, # Boolean specifying whether the field is indexed or not.
+ "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
+ "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
+ "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ },
+ "fieldId": "A String", # Unique identifier of Field (Read-only)
+ "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
+ },
+ ],
+ "kind": "admin#directory#schema", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "schemaId": "A String", # Unique identifier of Schema (Read-only)
+ "schemaName": "A String", # Schema name
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(customerId)</code>
+ <pre>Retrieve all schemas for a customer
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON response template for List Schema operation in Directory API.
+ "kind": "admin#directory#schemas", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "schemas": [ # List of UserSchema objects.
+ { # JSON template for Schema resource in Directory API.
+ "fields": [ # Fields of Schema
+ { # JSON template for FieldSpec resource for Schemas in Directory API.
+ "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "fieldName": "A String", # Name of the field.
+ "fieldType": "A String", # Type of the field.
+ "indexed": true, # Boolean specifying whether the field is indexed or not.
+ "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
+ "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
+ "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ },
+ "fieldId": "A String", # Unique identifier of Field (Read-only)
+ "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
+ },
+ ],
+ "kind": "admin#directory#schema", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "schemaId": "A String", # Unique identifier of Schema (Read-only)
+ "schemaName": "A String", # Schema name
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(customerId, schemaKey, body)</code>
+ <pre>Update schema. This method supports patch semantics.
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ schemaKey: string, Name or immutable Id of the schema. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Schema resource in Directory API.
+ "fields": [ # Fields of Schema
+ { # JSON template for FieldSpec resource for Schemas in Directory API.
+ "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "fieldName": "A String", # Name of the field.
+ "fieldType": "A String", # Type of the field.
+ "indexed": true, # Boolean specifying whether the field is indexed or not.
+ "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
+ "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
+ "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ },
+ "fieldId": "A String", # Unique identifier of Field (Read-only)
+ "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
+ },
+ ],
+ "kind": "admin#directory#schema", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "schemaId": "A String", # Unique identifier of Schema (Read-only)
+ "schemaName": "A String", # Schema name
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Schema resource in Directory API.
+ "fields": [ # Fields of Schema
+ { # JSON template for FieldSpec resource for Schemas in Directory API.
+ "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "fieldName": "A String", # Name of the field.
+ "fieldType": "A String", # Type of the field.
+ "indexed": true, # Boolean specifying whether the field is indexed or not.
+ "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
+ "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
+ "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ },
+ "fieldId": "A String", # Unique identifier of Field (Read-only)
+ "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
+ },
+ ],
+ "kind": "admin#directory#schema", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "schemaId": "A String", # Unique identifier of Schema (Read-only)
+ "schemaName": "A String", # Schema name
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(customerId, schemaKey, body)</code>
+ <pre>Update schema
+
+Args:
+ customerId: string, Immutable id of the Google Apps account (required)
+ schemaKey: string, Name or immutable Id of the schema. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Schema resource in Directory API.
+ "fields": [ # Fields of Schema
+ { # JSON template for FieldSpec resource for Schemas in Directory API.
+ "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "fieldName": "A String", # Name of the field.
+ "fieldType": "A String", # Type of the field.
+ "indexed": true, # Boolean specifying whether the field is indexed or not.
+ "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
+ "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
+ "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ },
+ "fieldId": "A String", # Unique identifier of Field (Read-only)
+ "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
+ },
+ ],
+ "kind": "admin#directory#schema", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "schemaId": "A String", # Unique identifier of Schema (Read-only)
+ "schemaName": "A String", # Schema name
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Schema resource in Directory API.
+ "fields": [ # Fields of Schema
+ { # JSON template for FieldSpec resource for Schemas in Directory API.
+ "kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "fieldName": "A String", # Name of the field.
+ "fieldType": "A String", # Type of the field.
+ "indexed": true, # Boolean specifying whether the field is indexed or not.
+ "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
+ "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
+ "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
+ },
+ "fieldId": "A String", # Unique identifier of Field (Read-only)
+ "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
+ },
+ ],
+ "kind": "admin#directory#schema", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "schemaId": "A String", # Unique identifier of Schema (Read-only)
+ "schemaName": "A String", # Schema name
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.tokens.html b/docs/dyn/admin_directory_v1.tokens.html
new file mode 100644
index 0000000..94cf066
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.tokens.html
@@ -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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.tokens.html">tokens</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(userKey, clientId)</a></code></p>
+<p class="firstline">Delete all access tokens issued by a user for an application.</p>
+<p class="toc_element">
+ <code><a href="#get">get(userKey, clientId)</a></code></p>
+<p class="firstline">Get information about an access token issued by a user.</p>
+<p class="toc_element">
+ <code><a href="#list">list(userKey)</a></code></p>
+<p class="firstline">Returns the set of tokens specified user has issued to 3rd party applications.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(userKey, clientId)</code>
+ <pre>Delete all access tokens issued by a user for an application.
+
+Args:
+ userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
+ clientId: string, The Client ID of the application the token is issued to. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(userKey, clientId)</code>
+ <pre>Get information about an access token issued by a user.
+
+Args:
+ userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
+ clientId: string, The Client ID of the application the token is issued to. (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON template for token resource in Directory API.
+ "scopes": [ # A list of authorization scopes the application is granted.
+ "A String",
+ ],
+ "kind": "admin#directory#token", # The type of the API resource. This is always admin#directory#token.
+ "nativeApp": True or False, # Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device.
+ "clientId": "A String", # The Client ID of the application the token is issued to.
+ "etag": "A String", # ETag of the resource.
+ "displayText": "A String", # The displayable name of the application the token is issued to.
+ "anonymous": True or False, # Whether the application is registered with Google. The value is true if the application has an anonymous Client ID.
+ "userKey": "A String", # The unique ID of the user that issued the token.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(userKey)</code>
+ <pre>Returns the set of tokens specified user has issued to 3rd party applications.
+
+Args:
+ userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON response template for List tokens operation in Directory API.
+ "items": [ # A list of Token resources.
+ { # JSON template for token resource in Directory API.
+ "scopes": [ # A list of authorization scopes the application is granted.
+ "A String",
+ ],
+ "kind": "admin#directory#token", # The type of the API resource. This is always admin#directory#token.
+ "nativeApp": True or False, # Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device.
+ "clientId": "A String", # The Client ID of the application the token is issued to.
+ "etag": "A String", # ETag of the resource.
+ "displayText": "A String", # The displayable name of the application the token is issued to.
+ "anonymous": True or False, # Whether the application is registered with Google. The value is true if the application has an anonymous Client ID.
+ "userKey": "A String", # The unique ID of the user that issued the token.
+ },
+ ],
+ "kind": "admin#directory#tokenList", # The type of the API resource. This is always admin#directory#tokenList.
+ "etag": "A String", # ETag of the resource.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.users.aliases.html b/docs/dyn/admin_directory_v1.users.aliases.html
new file mode 100644
index 0000000..8271f8b
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.users.aliases.html
@@ -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="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.users.html">users</a> . <a href="admin_directory_v1.users.aliases.html">aliases</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(userKey, alias)</a></code></p>
+<p class="firstline">Remove a alias for the user</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(userKey, body)</a></code></p>
+<p class="firstline">Add a alias for the user</p>
+<p class="toc_element">
+ <code><a href="#list">list(userKey, event=None)</a></code></p>
+<p class="firstline">List all aliases for a user</p>
+<p class="toc_element">
+ <code><a href="#watch">watch(userKey, body, event=None)</a></code></p>
+<p class="firstline">Watch for changes in user aliases list</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(userKey, alias)</code>
+ <pre>Remove a alias for the user
+
+Args:
+ userKey: string, Email or immutable Id of the user (required)
+ alias: string, The alias to be removed (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(userKey, body)</code>
+ <pre>Add a alias for the user
+
+Args:
+ userKey: string, Email or immutable Id of the user (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Alias object in Directory API.
+ "alias": "A String", # A alias email
+ "kind": "admin#directory#alias", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
+ "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Alias object in Directory API.
+ "alias": "A String", # A alias email
+ "kind": "admin#directory#alias", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
+ "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(userKey, event=None)</code>
+ <pre>List all aliases for a user
+
+Args:
+ userKey: string, Email or immutable Id of the user (required)
+ event: string, Event on which subscription is intended (if subscribing)
+ Allowed values
+ add - Alias Created Event
+ delete - Alias Deleted Event
+
+Returns:
+ An object of the form:
+
+ { # JSON response template to list aliases in Directory API.
+ "kind": "admin#directory#aliases", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "aliases": [ # List of alias objects.
+ "",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="watch">watch(userKey, body, event=None)</code>
+ <pre>Watch for changes in user aliases list
+
+Args:
+ userKey: string, Email or immutable Id of the user (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An notification channel used to watch for resource changes.
+ "resourceUri": "A String", # A version-specific identifier for the watched resource.
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+ "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+ "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+ "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+ "params": { # Additional parameters controlling delivery channel behavior. Optional.
+ "a_key": "A String", # Declares a new parameter by name.
+ },
+ "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+ "address": "A String", # The address where notifications are delivered for this channel.
+ "type": "A String", # The type of delivery mechanism used for this channel.
+ "id": "A String", # A UUID or similar unique string that identifies this channel.
+ }
+
+ event: string, Event on which subscription is intended (if subscribing)
+ Allowed values
+ add - Alias Created Event
+ delete - Alias Deleted Event
+
+Returns:
+ An object of the form:
+
+ { # An notification channel used to watch for resource changes.
+ "resourceUri": "A String", # A version-specific identifier for the watched resource.
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+ "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+ "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+ "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+ "params": { # Additional parameters controlling delivery channel behavior. Optional.
+ "a_key": "A String", # Declares a new parameter by name.
+ },
+ "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+ "address": "A String", # The address where notifications are delivered for this channel.
+ "type": "A String", # The type of delivery mechanism used for this channel.
+ "id": "A String", # A UUID or similar unique string that identifies this channel.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.users.html b/docs/dyn/admin_directory_v1.users.html
new file mode 100644
index 0000000..8816c87
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.users.html
@@ -0,0 +1,760 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.users.html">users</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="admin_directory_v1.users.aliases.html">aliases()</a></code>
+</p>
+<p class="firstline">Returns the aliases Resource.</p>
+
+<p class="toc_element">
+ <code><a href="admin_directory_v1.users.photos.html">photos()</a></code>
+</p>
+<p class="firstline">Returns the photos Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#delete">delete(userKey)</a></code></p>
+<p class="firstline">Delete user</p>
+<p class="toc_element">
+ <code><a href="#get">get(userKey, projection=None, customFieldMask=None, viewType=None)</a></code></p>
+<p class="firstline">retrieve user</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(body)</a></code></p>
+<p class="firstline">create user.</p>
+<p class="toc_element">
+ <code><a href="#list">list(orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)</a></code></p>
+<p class="firstline">Retrieve either deleted users or all users in a domain (paginated)</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="#makeAdmin">makeAdmin(userKey, body)</a></code></p>
+<p class="firstline">change admin status of a user</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(userKey, body)</a></code></p>
+<p class="firstline">update user. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#undelete">undelete(userKey, body)</a></code></p>
+<p class="firstline">Undelete a deleted user</p>
+<p class="toc_element">
+ <code><a href="#update">update(userKey, body)</a></code></p>
+<p class="firstline">update user</p>
+<p class="toc_element">
+ <code><a href="#watch">watch(body, orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)</a></code></p>
+<p class="firstline">Watch for changes in users list</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(userKey)</code>
+ <pre>Delete user
+
+Args:
+ userKey: string, Email or immutable Id of the user (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(userKey, projection=None, customFieldMask=None, viewType=None)</code>
+ <pre>retrieve user
+
+Args:
+ userKey: string, Email or immutable Id of the user (required)
+ projection: string, What subset of fields to fetch for this user.
+ Allowed values
+ basic - Do not include any custom fields for the user.
+ custom - Include custom fields from schemas mentioned in customFieldMask.
+ full - Include all fields associated with this user.
+ customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
+ viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
+ Allowed values
+ admin_view - Fetches the ADMIN_VIEW of the user.
+ domain_public - Fetches the DOMAIN_PUBLIC view of the user.
+
+Returns:
+ An object of the form:
+
+ { # JSON template for User object in Directory API.
+ "addresses": "",
+ "phones": "",
+ "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
+ "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
+ "suspended": True or False, # Indicates if user is suspended
+ "id": "A String", # Unique identifier of User (Read-only)
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "customSchemas": { # Custom fields of the user.
+ "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
+ "a_key": "",
+ },
+ },
+ "deletionTime": "A String",
+ "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
+ "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
+ "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
+ "relations": "",
+ "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
+ "ims": "",
+ "etag": "A String", # ETag of the resource.
+ "lastLoginTime": "A String", # User's last login time. (Read-only)
+ "orgUnitPath": "A String", # OrgUnit of User
+ "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
+ "externalIds": "",
+ "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "primaryEmail": "A String", # username of User
+ "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
+ "password": "A String", # User's password
+ "emails": "",
+ "organizations": "",
+ "kind": "admin#directory#user", # Kind of resource this is.
+ "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
+ "name": { # JSON template for name of a user in Directory API. # User's name
+ "givenName": "A String", # First Name
+ "fullName": "A String", # Full Name
+ "familyName": "A String", # Last Name
+ },
+ "notes": "",
+ "creationTime": "A String", # User's Google account creation time. (Read-only)
+ "websites": "",
+ "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
+ "customerId": "A String", # CustomerId of User (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(body)</code>
+ <pre>create user.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for User object in Directory API.
+ "addresses": "",
+ "phones": "",
+ "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
+ "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
+ "suspended": True or False, # Indicates if user is suspended
+ "id": "A String", # Unique identifier of User (Read-only)
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "customSchemas": { # Custom fields of the user.
+ "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
+ "a_key": "",
+ },
+ },
+ "deletionTime": "A String",
+ "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
+ "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
+ "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
+ "relations": "",
+ "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
+ "ims": "",
+ "etag": "A String", # ETag of the resource.
+ "lastLoginTime": "A String", # User's last login time. (Read-only)
+ "orgUnitPath": "A String", # OrgUnit of User
+ "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
+ "externalIds": "",
+ "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "primaryEmail": "A String", # username of User
+ "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
+ "password": "A String", # User's password
+ "emails": "",
+ "organizations": "",
+ "kind": "admin#directory#user", # Kind of resource this is.
+ "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
+ "name": { # JSON template for name of a user in Directory API. # User's name
+ "givenName": "A String", # First Name
+ "fullName": "A String", # Full Name
+ "familyName": "A String", # Last Name
+ },
+ "notes": "",
+ "creationTime": "A String", # User's Google account creation time. (Read-only)
+ "websites": "",
+ "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
+ "customerId": "A String", # CustomerId of User (Read-only)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for User object in Directory API.
+ "addresses": "",
+ "phones": "",
+ "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
+ "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
+ "suspended": True or False, # Indicates if user is suspended
+ "id": "A String", # Unique identifier of User (Read-only)
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "customSchemas": { # Custom fields of the user.
+ "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
+ "a_key": "",
+ },
+ },
+ "deletionTime": "A String",
+ "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
+ "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
+ "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
+ "relations": "",
+ "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
+ "ims": "",
+ "etag": "A String", # ETag of the resource.
+ "lastLoginTime": "A String", # User's last login time. (Read-only)
+ "orgUnitPath": "A String", # OrgUnit of User
+ "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
+ "externalIds": "",
+ "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "primaryEmail": "A String", # username of User
+ "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
+ "password": "A String", # User's password
+ "emails": "",
+ "organizations": "",
+ "kind": "admin#directory#user", # Kind of resource this is.
+ "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
+ "name": { # JSON template for name of a user in Directory API. # User's name
+ "givenName": "A String", # First Name
+ "fullName": "A String", # Full Name
+ "familyName": "A String", # Last Name
+ },
+ "notes": "",
+ "creationTime": "A String", # User's Google account creation time. (Read-only)
+ "websites": "",
+ "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
+ "customerId": "A String", # CustomerId of User (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)</code>
+ <pre>Retrieve either deleted users or all users in a domain (paginated)
+
+Args:
+ orderBy: string, Column to use for sorting results
+ Allowed values
+ email - Primary email of the user.
+ familyName - User's family name.
+ givenName - User's given name.
+ domain: string, Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.
+ projection: string, What subset of fields to fetch for this user.
+ Allowed values
+ basic - Do not include any custom fields for the user.
+ custom - Include custom fields from schemas mentioned in customFieldMask.
+ full - Include all fields associated with this user.
+ query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
+ event: string, Event on which subscription is intended (if subscribing)
+ Allowed values
+ add - User Created Event
+ delete - User Deleted Event
+ makeAdmin - User Admin Status Change Event
+ undelete - User Undeleted Event
+ update - User Updated Event
+ showDeleted: string, If set to true retrieves the list of deleted users. Default is false
+ pageToken: string, Token to specify next page in the list
+ sortOrder: string, Whether to return results in ascending or descending order.
+ Allowed values
+ ASCENDING - Ascending order.
+ DESCENDING - Descending order.
+ maxResults: integer, Maximum number of results to return. Default is 100. Max allowed is 500
+ customer: string, Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
+ customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
+ viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
+ Allowed values
+ admin_view - Fetches the ADMIN_VIEW of the user.
+ domain_public - Fetches the DOMAIN_PUBLIC view of the user.
+
+Returns:
+ An object of the form:
+
+ { # JSON response template for List Users operation in Apps Directory API.
+ "nextPageToken": "A String", # Token used to access next page of this result.
+ "kind": "admin#directory#users", # Kind of resource this is.
+ "etag": "A String", # ETag of the resource.
+ "trigger_event": "A String", # Event that triggered this response (only used in case of Push Response)
+ "users": [ # List of user objects.
+ { # JSON template for User object in Directory API.
+ "addresses": "",
+ "phones": "",
+ "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
+ "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
+ "suspended": True or False, # Indicates if user is suspended
+ "id": "A String", # Unique identifier of User (Read-only)
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "customSchemas": { # Custom fields of the user.
+ "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
+ "a_key": "",
+ },
+ },
+ "deletionTime": "A String",
+ "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
+ "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
+ "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
+ "relations": "",
+ "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
+ "ims": "",
+ "etag": "A String", # ETag of the resource.
+ "lastLoginTime": "A String", # User's last login time. (Read-only)
+ "orgUnitPath": "A String", # OrgUnit of User
+ "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
+ "externalIds": "",
+ "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "primaryEmail": "A String", # username of User
+ "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
+ "password": "A String", # User's password
+ "emails": "",
+ "organizations": "",
+ "kind": "admin#directory#user", # Kind of resource this is.
+ "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
+ "name": { # JSON template for name of a user in Directory API. # User's name
+ "givenName": "A String", # First Name
+ "fullName": "A String", # Full Name
+ "familyName": "A String", # Last Name
+ },
+ "notes": "",
+ "creationTime": "A String", # User's Google account creation time. (Read-only)
+ "websites": "",
+ "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
+ "customerId": "A String", # CustomerId of User (Read-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="makeAdmin">makeAdmin(userKey, body)</code>
+ <pre>change admin status of a user
+
+Args:
+ userKey: string, Email or immutable Id of the user as admin (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON request template for setting/revoking admin status of a user in Directory API.
+ "status": True or False, # Boolean indicating new admin status of the user
+ }
+
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(userKey, body)</code>
+ <pre>update user. This method supports patch semantics.
+
+Args:
+ userKey: string, Email or immutable Id of the user. If Id, it should match with id of user object (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for User object in Directory API.
+ "addresses": "",
+ "phones": "",
+ "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
+ "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
+ "suspended": True or False, # Indicates if user is suspended
+ "id": "A String", # Unique identifier of User (Read-only)
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "customSchemas": { # Custom fields of the user.
+ "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
+ "a_key": "",
+ },
+ },
+ "deletionTime": "A String",
+ "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
+ "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
+ "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
+ "relations": "",
+ "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
+ "ims": "",
+ "etag": "A String", # ETag of the resource.
+ "lastLoginTime": "A String", # User's last login time. (Read-only)
+ "orgUnitPath": "A String", # OrgUnit of User
+ "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
+ "externalIds": "",
+ "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "primaryEmail": "A String", # username of User
+ "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
+ "password": "A String", # User's password
+ "emails": "",
+ "organizations": "",
+ "kind": "admin#directory#user", # Kind of resource this is.
+ "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
+ "name": { # JSON template for name of a user in Directory API. # User's name
+ "givenName": "A String", # First Name
+ "fullName": "A String", # Full Name
+ "familyName": "A String", # Last Name
+ },
+ "notes": "",
+ "creationTime": "A String", # User's Google account creation time. (Read-only)
+ "websites": "",
+ "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
+ "customerId": "A String", # CustomerId of User (Read-only)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for User object in Directory API.
+ "addresses": "",
+ "phones": "",
+ "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
+ "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
+ "suspended": True or False, # Indicates if user is suspended
+ "id": "A String", # Unique identifier of User (Read-only)
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "customSchemas": { # Custom fields of the user.
+ "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
+ "a_key": "",
+ },
+ },
+ "deletionTime": "A String",
+ "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
+ "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
+ "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
+ "relations": "",
+ "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
+ "ims": "",
+ "etag": "A String", # ETag of the resource.
+ "lastLoginTime": "A String", # User's last login time. (Read-only)
+ "orgUnitPath": "A String", # OrgUnit of User
+ "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
+ "externalIds": "",
+ "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "primaryEmail": "A String", # username of User
+ "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
+ "password": "A String", # User's password
+ "emails": "",
+ "organizations": "",
+ "kind": "admin#directory#user", # Kind of resource this is.
+ "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
+ "name": { # JSON template for name of a user in Directory API. # User's name
+ "givenName": "A String", # First Name
+ "fullName": "A String", # Full Name
+ "familyName": "A String", # Last Name
+ },
+ "notes": "",
+ "creationTime": "A String", # User's Google account creation time. (Read-only)
+ "websites": "",
+ "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
+ "customerId": "A String", # CustomerId of User (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="undelete">undelete(userKey, body)</code>
+ <pre>Undelete a deleted user
+
+Args:
+ userKey: string, The immutable id of the user (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON request template to undelete a user in Directory API.
+ "orgUnitPath": "A String", # OrgUnit of User
+ }
+
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(userKey, body)</code>
+ <pre>update user
+
+Args:
+ userKey: string, Email or immutable Id of the user. If Id, it should match with id of user object (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for User object in Directory API.
+ "addresses": "",
+ "phones": "",
+ "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
+ "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
+ "suspended": True or False, # Indicates if user is suspended
+ "id": "A String", # Unique identifier of User (Read-only)
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "customSchemas": { # Custom fields of the user.
+ "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
+ "a_key": "",
+ },
+ },
+ "deletionTime": "A String",
+ "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
+ "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
+ "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
+ "relations": "",
+ "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
+ "ims": "",
+ "etag": "A String", # ETag of the resource.
+ "lastLoginTime": "A String", # User's last login time. (Read-only)
+ "orgUnitPath": "A String", # OrgUnit of User
+ "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
+ "externalIds": "",
+ "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "primaryEmail": "A String", # username of User
+ "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
+ "password": "A String", # User's password
+ "emails": "",
+ "organizations": "",
+ "kind": "admin#directory#user", # Kind of resource this is.
+ "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
+ "name": { # JSON template for name of a user in Directory API. # User's name
+ "givenName": "A String", # First Name
+ "fullName": "A String", # Full Name
+ "familyName": "A String", # Last Name
+ },
+ "notes": "",
+ "creationTime": "A String", # User's Google account creation time. (Read-only)
+ "websites": "",
+ "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
+ "customerId": "A String", # CustomerId of User (Read-only)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for User object in Directory API.
+ "addresses": "",
+ "phones": "",
+ "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
+ "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
+ "suspended": True or False, # Indicates if user is suspended
+ "id": "A String", # Unique identifier of User (Read-only)
+ "aliases": [ # List of aliases (Read-only)
+ "A String",
+ ],
+ "nonEditableAliases": [ # List of non editable aliases (Read-only)
+ "A String",
+ ],
+ "customSchemas": { # Custom fields of the user.
+ "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
+ "a_key": "",
+ },
+ },
+ "deletionTime": "A String",
+ "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
+ "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
+ "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
+ "relations": "",
+ "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
+ "ims": "",
+ "etag": "A String", # ETag of the resource.
+ "lastLoginTime": "A String", # User's last login time. (Read-only)
+ "orgUnitPath": "A String", # OrgUnit of User
+ "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
+ "externalIds": "",
+ "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "primaryEmail": "A String", # username of User
+ "isMailboxSetup": True or False, # Is mailbox setup (Read-only)
+ "password": "A String", # User's password
+ "emails": "",
+ "organizations": "",
+ "kind": "admin#directory#user", # Kind of resource this is.
+ "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
+ "name": { # JSON template for name of a user in Directory API. # User's name
+ "givenName": "A String", # First Name
+ "fullName": "A String", # Full Name
+ "familyName": "A String", # Last Name
+ },
+ "notes": "",
+ "creationTime": "A String", # User's Google account creation time. (Read-only)
+ "websites": "",
+ "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
+ "customerId": "A String", # CustomerId of User (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="watch">watch(body, orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)</code>
+ <pre>Watch for changes in users list
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An notification channel used to watch for resource changes.
+ "resourceUri": "A String", # A version-specific identifier for the watched resource.
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+ "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+ "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+ "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+ "params": { # Additional parameters controlling delivery channel behavior. Optional.
+ "a_key": "A String", # Declares a new parameter by name.
+ },
+ "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+ "address": "A String", # The address where notifications are delivered for this channel.
+ "type": "A String", # The type of delivery mechanism used for this channel.
+ "id": "A String", # A UUID or similar unique string that identifies this channel.
+ }
+
+ orderBy: string, Column to use for sorting results
+ Allowed values
+ email - Primary email of the user.
+ familyName - User's family name.
+ givenName - User's given name.
+ domain: string, Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.
+ projection: string, What subset of fields to fetch for this user.
+ Allowed values
+ basic - Do not include any custom fields for the user.
+ custom - Include custom fields from schemas mentioned in customFieldMask.
+ full - Include all fields associated with this user.
+ query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
+ event: string, Event on which subscription is intended (if subscribing)
+ Allowed values
+ add - User Created Event
+ delete - User Deleted Event
+ makeAdmin - User Admin Status Change Event
+ undelete - User Undeleted Event
+ update - User Updated Event
+ showDeleted: string, If set to true retrieves the list of deleted users. Default is false
+ pageToken: string, Token to specify next page in the list
+ sortOrder: string, Whether to return results in ascending or descending order.
+ Allowed values
+ ASCENDING - Ascending order.
+ DESCENDING - Descending order.
+ maxResults: integer, Maximum number of results to return. Default is 100. Max allowed is 500
+ customer: string, Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
+ customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
+ viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
+ Allowed values
+ admin_view - Fetches the ADMIN_VIEW of the user.
+ domain_public - Fetches the DOMAIN_PUBLIC view of the user.
+
+Returns:
+ An object of the form:
+
+ { # An notification channel used to watch for resource changes.
+ "resourceUri": "A String", # A version-specific identifier for the watched resource.
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+ "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+ "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+ "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+ "params": { # Additional parameters controlling delivery channel behavior. Optional.
+ "a_key": "A String", # Declares a new parameter by name.
+ },
+ "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+ "address": "A String", # The address where notifications are delivered for this channel.
+ "type": "A String", # The type of delivery mechanism used for this channel.
+ "id": "A String", # A UUID or similar unique string that identifies this channel.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.users.photos.html b/docs/dyn/admin_directory_v1.users.photos.html
new file mode 100644
index 0000000..1851c8d
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.users.photos.html
@@ -0,0 +1,193 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.users.html">users</a> . <a href="admin_directory_v1.users.photos.html">photos</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(userKey)</a></code></p>
+<p class="firstline">Remove photos for the user</p>
+<p class="toc_element">
+ <code><a href="#get">get(userKey)</a></code></p>
+<p class="firstline">Retrieve photo of a user</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(userKey, body)</a></code></p>
+<p class="firstline">Add a photo for the user. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(userKey, body)</a></code></p>
+<p class="firstline">Add a photo for the user</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(userKey)</code>
+ <pre>Remove photos for the user
+
+Args:
+ userKey: string, Email or immutable Id of the user (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(userKey)</code>
+ <pre>Retrieve photo of a user
+
+Args:
+ userKey: string, Email or immutable Id of the user (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Photo object in Directory API.
+ "mimeType": "A String", # Mime Type of the photo
+ "kind": "admin#directory#user#photo", # Kind of resource this is.
+ "photoData": "A String", # Base64 encoded photo data
+ "height": 42, # Height in pixels of the photo
+ "width": 42, # Width in pixels of the photo
+ "etag": "A String", # ETag of the resource.
+ "primaryEmail": "A String", # Primary email of User (Read-only)
+ "id": "A String", # Unique identifier of User (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(userKey, body)</code>
+ <pre>Add a photo for the user. This method supports patch semantics.
+
+Args:
+ userKey: string, Email or immutable Id of the user (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Photo object in Directory API.
+ "mimeType": "A String", # Mime Type of the photo
+ "kind": "admin#directory#user#photo", # Kind of resource this is.
+ "photoData": "A String", # Base64 encoded photo data
+ "height": 42, # Height in pixels of the photo
+ "width": 42, # Width in pixels of the photo
+ "etag": "A String", # ETag of the resource.
+ "primaryEmail": "A String", # Primary email of User (Read-only)
+ "id": "A String", # Unique identifier of User (Read-only)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Photo object in Directory API.
+ "mimeType": "A String", # Mime Type of the photo
+ "kind": "admin#directory#user#photo", # Kind of resource this is.
+ "photoData": "A String", # Base64 encoded photo data
+ "height": 42, # Height in pixels of the photo
+ "width": 42, # Width in pixels of the photo
+ "etag": "A String", # ETag of the resource.
+ "primaryEmail": "A String", # Primary email of User (Read-only)
+ "id": "A String", # Unique identifier of User (Read-only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(userKey, body)</code>
+ <pre>Add a photo for the user
+
+Args:
+ userKey: string, Email or immutable Id of the user (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # JSON template for Photo object in Directory API.
+ "mimeType": "A String", # Mime Type of the photo
+ "kind": "admin#directory#user#photo", # Kind of resource this is.
+ "photoData": "A String", # Base64 encoded photo data
+ "height": 42, # Height in pixels of the photo
+ "width": 42, # Width in pixels of the photo
+ "etag": "A String", # ETag of the resource.
+ "primaryEmail": "A String", # Primary email of User (Read-only)
+ "id": "A String", # Unique identifier of User (Read-only)
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # JSON template for Photo object in Directory API.
+ "mimeType": "A String", # Mime Type of the photo
+ "kind": "admin#directory#user#photo", # Kind of resource this is.
+ "photoData": "A String", # Base64 encoded photo data
+ "height": 42, # Height in pixels of the photo
+ "width": 42, # Width in pixels of the photo
+ "etag": "A String", # ETag of the resource.
+ "primaryEmail": "A String", # Primary email of User (Read-only)
+ "id": "A String", # Unique identifier of User (Read-only)
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/admin_directory_v1.verificationCodes.html b/docs/dyn/admin_directory_v1.verificationCodes.html
new file mode 100644
index 0000000..859a399
--- /dev/null
+++ b/docs/dyn/admin_directory_v1.verificationCodes.html
@@ -0,0 +1,129 @@
+<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_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.verificationCodes.html">verificationCodes</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#generate">generate(userKey)</a></code></p>
+<p class="firstline">Generate new backup verification codes for the user.</p>
+<p class="toc_element">
+ <code><a href="#invalidate">invalidate(userKey)</a></code></p>
+<p class="firstline">Invalidate the current backup verification codes for the user.</p>
+<p class="toc_element">
+ <code><a href="#list">list(userKey)</a></code></p>
+<p class="firstline">Returns the current set of valid backup verification codes for the specified user.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="generate">generate(userKey)</code>
+ <pre>Generate new backup verification codes for the user.
+
+Args:
+ userKey: string, Email or immutable Id of the user (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="invalidate">invalidate(userKey)</code>
+ <pre>Invalidate the current backup verification codes for the user.
+
+Args:
+ userKey: string, Email or immutable Id of the user (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(userKey)</code>
+ <pre>Returns the current set of valid backup verification codes for the specified user.
+
+Args:
+ userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
+
+Returns:
+ An object of the form:
+
+ { # JSON response template for List verification codes operation in Directory API.
+ "items": [ # A list of verification code resources.
+ { # JSON template for verification codes in Directory API.
+ "kind": "admin#directory#verificationCode", # The type of the resource. This is always admin#directory#verificationCode.
+ "etag": "A String", # ETag of the resource.
+ "userId": "A String", # The obfuscated unique ID of the user.
+ "verificationCode": "A String", # A current verification code for the user. Invalidated or used verification codes are not returned as part of the result.
+ },
+ ],
+ "kind": "admin#directory#verificationCodesList", # The type of the resource. This is always admin#directory#verificationCodesList.
+ "etag": "A String", # ETag of the resource.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.accounts.adclients.html b/docs/dyn/adsense_v1_3.accounts.adclients.html
new file mode 100644
index 0000000..7cc13c1
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.accounts.adclients.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.accounts.adunits.customchannels.html b/docs/dyn/adsense_v1_3.accounts.adunits.customchannels.html
new file mode 100644
index 0000000..4a29e66
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.accounts.adunits.customchannels.html
@@ -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 (deprecated)). 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 (deprecated) 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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.accounts.adunits.html b/docs/dyn/adsense_v1_3.accounts.adunits.html
new file mode 100644
index 0000000..2451880
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.accounts.adunits.html
@@ -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) - deprecated.
+ "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 - deprecated).
+ "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) - deprecated.
+ "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) - deprecated.
+ "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 - deprecated).
+ "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) - deprecated.
+ "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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.accounts.alerts.html b/docs/dyn/adsense_v1_3.accounts.alerts.html
new file mode 100644
index 0000000..35f095f
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.accounts.alerts.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.accounts.customchannels.adunits.html b/docs/dyn/adsense_v1_3.accounts.customchannels.adunits.html
new file mode 100644
index 0000000..b0bf524
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.accounts.customchannels.adunits.html
@@ -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) - deprecated.
+ "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 - deprecated).
+ "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) - deprecated.
+ "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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.accounts.customchannels.html b/docs/dyn/adsense_v1_3.accounts.customchannels.html
new file mode 100644
index 0000000..fb93126
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.accounts.customchannels.html
@@ -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 (deprecated)). 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 (deprecated) 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 (deprecated)). 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 (deprecated) 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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.accounts.html b/docs/dyn/adsense_v1_3.accounts.html
new file mode 100644
index 0000000..b1e2266
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.accounts.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.accounts.reports.html b/docs/dyn/adsense_v1_3.accounts.reports.html
new file mode 100644
index 0000000..c75137a
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.accounts.reports.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.accounts.reports.saved.html b/docs/dyn/adsense_v1_3.accounts.reports.saved.html
new file mode 100644
index 0000000..971a2ad
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.accounts.reports.saved.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.accounts.savedadstyles.html b/docs/dyn/adsense_v1_3.accounts.savedadstyles.html
new file mode 100644
index 0000000..12ccac8
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.accounts.savedadstyles.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.accounts.urlchannels.html b/docs/dyn/adsense_v1_3.accounts.urlchannels.html
new file mode 100644
index 0000000..c024486
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.accounts.urlchannels.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.adclients.html b/docs/dyn/adsense_v1_3.adclients.html
new file mode 100644
index 0000000..58a4541
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.adclients.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.adunits.customchannels.html b/docs/dyn/adsense_v1_3.adunits.customchannels.html
new file mode 100644
index 0000000..a04f260
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.adunits.customchannels.html
@@ -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 (deprecated)). 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 (deprecated) 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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.adunits.html b/docs/dyn/adsense_v1_3.adunits.html
new file mode 100644
index 0000000..010c9ab
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.adunits.html
@@ -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) - deprecated.
+ "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 - deprecated).
+ "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) - deprecated.
+ "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) - deprecated.
+ "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 - deprecated).
+ "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) - deprecated.
+ "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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.alerts.html b/docs/dyn/adsense_v1_3.alerts.html
new file mode 100644
index 0000000..513bec1
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.alerts.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.customchannels.adunits.html b/docs/dyn/adsense_v1_3.customchannels.adunits.html
new file mode 100644
index 0000000..973aeb2
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.customchannels.adunits.html
@@ -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) - deprecated.
+ "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 - deprecated).
+ "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) - deprecated.
+ "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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.customchannels.html b/docs/dyn/adsense_v1_3.customchannels.html
new file mode 100644
index 0000000..3710075
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.customchannels.html
@@ -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 (deprecated)). 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 (deprecated) 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 (deprecated)). 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 (deprecated) 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>
\ No newline at end of file
diff --git a/docs/dyn/gan_v1beta1.html b/docs/dyn/adsense_v1_3.html
similarity index 63%
copy from docs/dyn/gan_v1beta1.html
copy to docs/dyn/adsense_v1_3.html
index a51a20f..ee71189 100644
--- a/docs/dyn/gan_v1beta1.html
+++ b/docs/dyn/adsense_v1_3.html
@@ -72,39 +72,54 @@
</style>
-<h1><a href="gan_v1beta1.html">Google Affiliate Network API</a></h1>
+<h1><a href="adsense_v1_3.html">AdSense Management API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="gan_v1beta1.advertisers.html">advertisers()</a></code>
+ <code><a href="adsense_v1_3.accounts.html">accounts()</a></code>
</p>
-<p class="firstline">Returns the advertisers Resource.</p>
+<p class="firstline">Returns the accounts Resource.</p>
<p class="toc_element">
- <code><a href="gan_v1beta1.ccOffers.html">ccOffers()</a></code>
+ <code><a href="adsense_v1_3.adclients.html">adclients()</a></code>
</p>
-<p class="firstline">Returns the ccOffers Resource.</p>
+<p class="firstline">Returns the adclients Resource.</p>
<p class="toc_element">
- <code><a href="gan_v1beta1.events.html">events()</a></code>
+ <code><a href="adsense_v1_3.adunits.html">adunits()</a></code>
</p>
-<p class="firstline">Returns the events Resource.</p>
+<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
- <code><a href="gan_v1beta1.links.html">links()</a></code>
+ <code><a href="adsense_v1_3.alerts.html">alerts()</a></code>
</p>
-<p class="firstline">Returns the links Resource.</p>
+<p class="firstline">Returns the alerts Resource.</p>
<p class="toc_element">
- <code><a href="gan_v1beta1.publishers.html">publishers()</a></code>
+ <code><a href="adsense_v1_3.customchannels.html">customchannels()</a></code>
</p>
-<p class="firstline">Returns the publishers Resource.</p>
+<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
- <code><a href="gan_v1beta1.reports.html">reports()</a></code>
+ <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>
+
+<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
<h3>Method Details</h3>
diff --git a/docs/dyn/adsense_v1_3.metadata.dimensions.html b/docs/dyn/adsense_v1_3.metadata.dimensions.html
new file mode 100644
index 0000000..e59c54f
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.metadata.dimensions.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/dataflow_v1beta3.v1b3.projects.html b/docs/dyn/adsense_v1_3.metadata.html
similarity index 70%
copy from docs/dyn/dataflow_v1beta3.v1b3.projects.html
copy to docs/dyn/adsense_v1_3.metadata.html
index 8f220f1..c1aee39 100644
--- a/docs/dyn/dataflow_v1beta3.v1b3.projects.html
+++ b/docs/dyn/adsense_v1_3.metadata.html
@@ -72,11 +72,16 @@
</style>
-<h1><a href="dataflow_v1beta3.html">Google Dataflow API</a> . <a href="dataflow_v1beta3.v1b3.html">v1b3</a> . <a href="dataflow_v1beta3.v1b3.projects.html">projects</a></h1>
+<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="dataflow_v1beta3.v1b3.projects.jobs.html">jobs()</a></code>
+ <code><a href="adsense_v1_3.metadata.dimensions.html">dimensions()</a></code>
</p>
-<p class="firstline">Returns the jobs Resource.</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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.metadata.metrics.html b/docs/dyn/adsense_v1_3.metadata.metrics.html
new file mode 100644
index 0000000..754349f
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.metadata.metrics.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.reports.html b/docs/dyn/adsense_v1_3.reports.html
new file mode 100644
index 0000000..ff3f34a
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.reports.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.reports.saved.html b/docs/dyn/adsense_v1_3.reports.saved.html
new file mode 100644
index 0000000..e64429d
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.reports.saved.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.savedadstyles.html b/docs/dyn/adsense_v1_3.savedadstyles.html
new file mode 100644
index 0000000..4a663e1
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.savedadstyles.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.urlchannels.html b/docs/dyn/adsense_v1_3.urlchannels.html
new file mode 100644
index 0000000..b3bf582
--- /dev/null
+++ b/docs/dyn/adsense_v1_3.urlchannels.html
@@ -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>
\ No newline at end of file
diff --git a/docs/dyn/analytics_v2_4.data.html b/docs/dyn/analytics_v2_4.data.html
new file mode 100644
index 0000000..dd55c96
--- /dev/null
+++ b/docs/dyn/analytics_v2_4.data.html
@@ -0,0 +1,99 @@
+<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_v2_4.html">Google Analytics API</a> . <a href="analytics_v2_4.data.html">data</a></h1>
+<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 report 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 report data for a view (profile).
+
+Args:
+ ids: string, Unique table ID for retrieving report 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 report data. All requests should specify a start date formatted as YYYY-MM-DD. (required)
+ end_date: string, End date for fetching report 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:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report. (required)
+ sort: string, A comma-separated list of dimensions or metrics that determine the sort order for the report data.
+ dimensions: string, A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
+ filters: string, A comma-separated list of dimension or metric filters to be applied to the report data.
+ max_results: integer, The maximum number of entries to include in this feed.
+ segment: string, An Analytics advanced segment to be applied to the report data.
+ start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
+</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/manager_v1beta2.html b/docs/dyn/analytics_v2_4.html
similarity index 85%
copy from docs/dyn/manager_v1beta2.html
copy to docs/dyn/analytics_v2_4.html
index 44fc028..ffd3e0b 100644
--- a/docs/dyn/manager_v1beta2.html
+++ b/docs/dyn/analytics_v2_4.html
@@ -72,17 +72,17 @@
</style>
-<h1><a href="manager_v1beta2.html">Deployment Manager API</a></h1>
+<h1><a href="analytics_v2_4.html">Google Analytics API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="manager_v1beta2.deployments.html">deployments()</a></code>
+ <code><a href="analytics_v2_4.data.html">data()</a></code>
</p>
-<p class="firstline">Returns the deployments Resource.</p>
+<p class="firstline">Returns the data Resource.</p>
<p class="toc_element">
- <code><a href="manager_v1beta2.templates.html">templates()</a></code>
+ <code><a href="analytics_v2_4.management.html">management()</a></code>
</p>
-<p class="firstline">Returns the templates Resource.</p>
+<p class="firstline">Returns the management Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/analytics_v2_4.management.accounts.html b/docs/dyn/analytics_v2_4.management.accounts.html
new file mode 100644
index 0000000..84cfca4
--- /dev/null
+++ b/docs/dyn/analytics_v2_4.management.accounts.html
@@ -0,0 +1,91 @@
+<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_v2_4.html">Google Analytics API</a> . <a href="analytics_v2_4.management.html">management</a> . <a href="analytics_v2_4.management.accounts.html">accounts</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(max_results=None, start_index=None)</a></code></p>
+<p class="firstline">Lists all accounts to which the user has access.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(max_results=None, start_index=None)</code>
+ <pre>Lists all accounts to which the user has access.
+
+Args:
+ max_results: integer, The maximum number of accounts to include in this response.
+ start_index: integer, An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
+</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/analytics_v2_4.management.goals.html b/docs/dyn/analytics_v2_4.management.goals.html
new file mode 100644
index 0000000..112ac52
--- /dev/null
+++ b/docs/dyn/analytics_v2_4.management.goals.html
@@ -0,0 +1,94 @@
+<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_v2_4.html">Google Analytics API</a> . <a href="analytics_v2_4.management.html">management</a> . <a href="analytics_v2_4.management.goals.html">goals</a></h1>
+<h2>Instance Methods</h2>
+<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 goals to which the user has access.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code>
+ <pre>Lists goals to which the user has access.
+
+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, 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.
+</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/analytics_v2_4.management.html b/docs/dyn/analytics_v2_4.management.html
new file mode 100644
index 0000000..fafeb33
--- /dev/null
+++ b/docs/dyn/analytics_v2_4.management.html
@@ -0,0 +1,102 @@
+<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_v2_4.html">Google Analytics API</a> . <a href="analytics_v2_4.management.html">management</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="analytics_v2_4.management.accounts.html">accounts()</a></code>
+</p>
+<p class="firstline">Returns the accounts Resource.</p>
+
+<p class="toc_element">
+ <code><a href="analytics_v2_4.management.goals.html">goals()</a></code>
+</p>
+<p class="firstline">Returns the goals Resource.</p>
+
+<p class="toc_element">
+ <code><a href="analytics_v2_4.management.profiles.html">profiles()</a></code>
+</p>
+<p class="firstline">Returns the profiles Resource.</p>
+
+<p class="toc_element">
+ <code><a href="analytics_v2_4.management.segments.html">segments()</a></code>
+</p>
+<p class="firstline">Returns the segments Resource.</p>
+
+<p class="toc_element">
+ <code><a href="analytics_v2_4.management.webproperties.html">webproperties()</a></code>
+</p>
+<p class="firstline">Returns the webproperties Resource.</p>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/analytics_v2_4.management.profiles.html b/docs/dyn/analytics_v2_4.management.profiles.html
new file mode 100644
index 0000000..c8df69e
--- /dev/null
+++ b/docs/dyn/analytics_v2_4.management.profiles.html
@@ -0,0 +1,93 @@
+<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_v2_4.html">Google Analytics API</a> . <a href="analytics_v2_4.management.html">management</a> . <a href="analytics_v2_4.management.profiles.html">profiles</a></h1>
+<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 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 views (profiles) to which the user has access.
+
+Args:
+ accountId: string, Account ID for the views (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.
+</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/analytics_v2_4.management.segments.html b/docs/dyn/analytics_v2_4.management.segments.html
new file mode 100644
index 0000000..0f25fda
--- /dev/null
+++ b/docs/dyn/analytics_v2_4.management.segments.html
@@ -0,0 +1,91 @@
+<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_v2_4.html">Google Analytics API</a> . <a href="analytics_v2_4.management.html">management</a> . <a href="analytics_v2_4.management.segments.html">segments</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(max_results=None, start_index=None)</a></code></p>
+<p class="firstline">Lists advanced segments to which the user has access.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(max_results=None, start_index=None)</code>
+ <pre>Lists advanced segments to which the user has access.
+
+Args:
+ max_results: integer, The maximum number of advanced segments to include in this response.
+ start_index: integer, An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
+</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/analytics_v2_4.management.webproperties.html b/docs/dyn/analytics_v2_4.management.webproperties.html
new file mode 100644
index 0000000..d6f9fee
--- /dev/null
+++ b/docs/dyn/analytics_v2_4.management.webproperties.html
@@ -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="analytics_v2_4.html">Google Analytics API</a> . <a href="analytics_v2_4.management.html">management</a> . <a href="analytics_v2_4.management.webproperties.html">webproperties</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(accountId, max_results=None, start_index=None)</a></code></p>
+<p class="firstline">Lists web properties to which the user has access.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(accountId, max_results=None, start_index=None)</code>
+ <pre>Lists web properties to which the user has access.
+
+Args:
+ accountId: string, Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. (required)
+ max_results: integer, The maximum number of web properties 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.
+</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/analytics_v3.management.dailyUploads.html b/docs/dyn/analytics_v3.management.dailyUploads.html
deleted file mode 100644
index 80428b9..0000000
--- a/docs/dyn/analytics_v3.management.dailyUploads.html
+++ /dev/null
@@ -1,182 +0,0 @@
-<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.dailyUploads.html">dailyUploads</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(accountId, webPropertyId, customDataSourceId, date, type)</a></code></p>
-<p class="firstline">Delete uploaded data for the given date.</p>
-<p class="toc_element">
- <code><a href="#list">list(accountId, webPropertyId, customDataSourceId, start_date, end_date, max_results=None, start_index=None)</a></code></p>
-<p class="firstline">List daily uploads to which the user has access.</p>
-<p class="toc_element">
- <code><a href="#upload">upload(accountId, webPropertyId, customDataSourceId, date, appendNumber, type, reset=None, media_body=None)</a></code></p>
-<p class="firstline">Update/Overwrite data for a custom data source.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(accountId, webPropertyId, customDataSourceId, date, type)</code>
- <pre>Delete uploaded data for the given date.
-
-Args:
- accountId: string, Account Id associated with daily upload delete. (required)
- webPropertyId: string, Web property Id associated with daily upload delete. (required)
- customDataSourceId: string, Custom data source Id associated with daily upload delete. (required)
- date: string, Date for which data is to be deleted. Date should be formatted as YYYY-MM-DD. (required)
- type: string, Type of data for this delete. (required)
- Allowed values
- cost - Value for specifying cost data upload.
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(accountId, webPropertyId, customDataSourceId, start_date, end_date, max_results=None, start_index=None)</code>
- <pre>List daily uploads to which the user has access.
-
-Args:
- accountId: string, Account Id for the daily uploads to retrieve. (required)
- webPropertyId: string, Web property Id for the daily uploads to retrieve. (required)
- customDataSourceId: string, Custom data source Id for daily uploads to retrieve. (required)
- start_date: string, Start date of the form YYYY-MM-DD. (required)
- end_date: string, End date of the form YYYY-MM-DD. (required)
- max_results: integer, The maximum number of custom data sources to include in this response.
- start_index: integer, A 1-based index of the first daily upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
-
-Returns:
- An object of the form:
-
- { # A daily upload collection lists Analytics daily uploads to which the user has access. Each resource in the collection corresponds to a single Analytics daily upload.
- "username": "A String", # Email ID of the authenticated user
- "kind": "analytics#dailyUploads", # Collection type. Value is analytics#dailyUploads.
- "items": [ # A collection of daily uploads.
- { # Metadata for daily upload entity.
- "recentChanges": [ # Change log for last 10 changes in chronological order.
- {
- "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.
- "modifiedTime": "A String", # Time this daily upload was last modified.
- "appendCount": 42, # Number of appends for this date.
- "customDataSourceId": "A String", # Custom data source ID to which this daily upload belongs.
- "date": "A String", # Date associated with daily upload.
- "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this daily upload belongs.
- "createdTime": "A String", # Time this daily upload was created.
- "parentLink": { # Parent link for a daily upload. Points to the custom data source to which this daily upload belongs.
- "href": "A String", # Link to the custom data source to which this daily upload belongs.
- "type": "analytics#customDataSource", # Value is "analytics#customDataSource".
- },
- "selfLink": "A String", # Link for this daily upload.
- "accountId": "A String", # Account ID to which this daily upload 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 daily upload 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 daily upload collection.
- "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="upload">upload(accountId, webPropertyId, customDataSourceId, date, appendNumber, type, reset=None, media_body=None)</code>
- <pre>Update/Overwrite data for a custom data source.
-
-Args:
- accountId: string, Account Id associated with daily upload. (required)
- webPropertyId: string, Web property Id associated with daily upload. (required)
- customDataSourceId: string, Custom data source Id to which the data being uploaded belongs. (required)
- date: string, Date for which data is uploaded. Date should be formatted as YYYY-MM-DD. (required)
- appendNumber: integer, Append number for this upload indexed from 1. (required)
- type: string, Type of data for this upload. (required)
- Allowed values
- cost - Value for specifying cost data upload.
- reset: boolean, Reset/Overwrite all previous appends for this date and start over with this file as the first upload.
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
-
-Returns:
- An object of the form:
-
- { # Metadata returned for a successful append operation.
- "kind": "analytics#dailyUploadAppend", # Resource type for Analytics daily upload append.
- "customDataSourceId": "A String", # Custom data source Id to which this daily upload append belongs.
- "appendNumber": 42, # Append number.
- "webPropertyId": "A String", # Web property Id of the form UA-XXXXX-YY to which this daily upload append belongs.
- "date": "A String", # Date associated with daily upload append.
- "nextAppendLink": "A String",
- "accountId": "A String", # Account Id to which this daily upload append belongs.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidenterprise_v1.users.html b/docs/dyn/androidenterprise_v1.users.html
index 169559c..0ea296f 100644
--- a/docs/dyn/androidenterprise_v1.users.html
+++ b/docs/dyn/androidenterprise_v1.users.html
@@ -194,6 +194,7 @@
{ # A set of products.
"kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
+ "productSetBehavior": "A String", # The interpretation of this product set. "unknown" should never be sent and ignored if received. "whitelist" means that this product set constitutes a whitelist. "includeAll" means that all products are accessible (the value of the productId field is therefore ignored). If a value is not supplied, it is interpreted to be "whitelist" for backwards compatibility.
"productId": [ # The list of product IDs making up the set of products.
"A String",
],
@@ -333,6 +334,7 @@
{ # A set of products.
"kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
+ "productSetBehavior": "A String", # The interpretation of this product set. "unknown" should never be sent and ignored if received. "whitelist" means that this product set constitutes a whitelist. "includeAll" means that all products are accessible (the value of the productId field is therefore ignored). If a value is not supplied, it is interpreted to be "whitelist" for backwards compatibility.
"productId": [ # The list of product IDs making up the set of products.
"A String",
],
@@ -344,6 +346,7 @@
{ # A set of products.
"kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
+ "productSetBehavior": "A String", # The interpretation of this product set. "unknown" should never be sent and ignored if received. "whitelist" means that this product set constitutes a whitelist. "includeAll" means that all products are accessible (the value of the productId field is therefore ignored). If a value is not supplied, it is interpreted to be "whitelist" for backwards compatibility.
"productId": [ # The list of product IDs making up the set of products.
"A String",
],
diff --git a/docs/dyn/logging_v1beta3.html b/docs/dyn/androidpublisher_v1.html
similarity index 90%
copy from docs/dyn/logging_v1beta3.html
copy to docs/dyn/androidpublisher_v1.html
index db3cf63..86238c4 100644
--- a/docs/dyn/logging_v1beta3.html
+++ b/docs/dyn/androidpublisher_v1.html
@@ -72,12 +72,12 @@
</style>
-<h1><a href="logging_v1beta3.html">Google Cloud Logging API</a></h1>
+<h1><a href="androidpublisher_v1.html">Google Play Developer API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="logging_v1beta3.projects.html">projects()</a></code>
+ <code><a href="androidpublisher_v1.purchases.html">purchases()</a></code>
</p>
-<p class="firstline">Returns the projects Resource.</p>
+<p class="firstline">Returns the purchases Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/androidpublisher_v1.purchases.html b/docs/dyn/androidpublisher_v1.purchases.html
new file mode 100644
index 0000000..393ccce
--- /dev/null
+++ b/docs/dyn/androidpublisher_v1.purchases.html
@@ -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.html">Google Play Developer API</a> . <a href="androidpublisher_v1.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 SubscriptionPurchase resource indicates the status of a user's subscription purchase.
+ "initiationTimestampMsec": "A String", # Time at which the subscription was granted, in milliseconds since the 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 the Epoch.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidpublisher_v1_1.html b/docs/dyn/androidpublisher_v1_1.html
index adf06a6..65b83bc 100644
--- a/docs/dyn/androidpublisher_v1_1.html
+++ b/docs/dyn/androidpublisher_v1_1.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v1_1.html">Google Play Android Developer API</a></h1>
+<h1><a href="androidpublisher_v1_1.html">Google Play Developer API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="androidpublisher_v1_1.inapppurchases.html">inapppurchases()</a></code>
@@ -84,4 +84,25 @@
</p>
<p class="firstline">Returns the purchases Resource.</p>
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidpublisher_v1_1.inapppurchases.html b/docs/dyn/androidpublisher_v1_1.inapppurchases.html
index 56f0ed5..5374db2 100644
--- a/docs/dyn/androidpublisher_v1_1.inapppurchases.html
+++ b/docs/dyn/androidpublisher_v1_1.inapppurchases.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v1_1.html">Google Play Android Developer API</a> . <a href="androidpublisher_v1_1.inapppurchases.html">inapppurchases</a></h1>
+<h1><a href="androidpublisher_v1_1.html">Google Play 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>
@@ -90,12 +90,12 @@
Returns:
An object of the form:
- { # A Purchase resource indicates the status of a user's subscription purchase.
+ { # An InappPurchase resource indicates the status of a user's inapp product purchase.
"consumptionState": 42, # The consumption state of the inapp product. Possible values are:
# - Yet to be consumed
# - 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.
+ "kind": "androidpublisher#inappPurchase", # This kind represents an 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
diff --git a/docs/dyn/androidpublisher_v1_1.purchases.html b/docs/dyn/androidpublisher_v1_1.purchases.html
index f556adc..ea9c472 100644
--- a/docs/dyn/androidpublisher_v1_1.purchases.html
+++ b/docs/dyn/androidpublisher_v1_1.purchases.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="androidpublisher_v1_1.html">Google Play Android Developer API</a> . <a href="androidpublisher_v1_1.purchases.html">purchases</a></h1>
+<h1><a href="androidpublisher_v1_1.html">Google Play 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>
@@ -104,11 +104,11 @@
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.
+ { # A SubscriptionPurchase resource indicates the status of a user's subscription purchase.
+ "initiationTimestampMsec": "A String", # Time at which the subscription was granted, in milliseconds since the 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.
+ "validUntilTimestampMsec": "A String", # Time at which the subscription will expire, in milliseconds since the Epoch.
}</pre>
</div>
diff --git a/docs/dyn/androidpublisher_v2.edits.deobfuscationfiles.html b/docs/dyn/androidpublisher_v2.edits.deobfuscationfiles.html
new file mode 100644
index 0000000..14e2f10
--- /dev/null
+++ b/docs/dyn/androidpublisher_v2.edits.deobfuscationfiles.html
@@ -0,0 +1,104 @@
+<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_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.deobfuscationfiles.html">deobfuscationfiles</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#upload">upload(packageName, editId, apkVersionCode, deobfuscationFileType, media_body=None)</a></code></p>
+<p class="firstline">Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="upload">upload(packageName, editId, apkVersionCode, deobfuscationFileType, media_body=None)</code>
+ <pre>Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced.
+
+Args:
+ packageName: string, Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame". (required)
+ editId: string, Unique identifier for this edit. (required)
+ apkVersionCode: integer, The version code of the APK whose deobfuscation file is being uploaded. (required)
+ deobfuscationFileType: string, A parameter (required)
+ Allowed values
+ proguard -
+ media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+
+Returns:
+ An object of the form:
+
+ {
+ "deobfuscationFile": { # Represents a deobfuscation file.
+ "symbolType": "A String", # The type of the deobfuscation file.
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/androidpublisher_v2.edits.html b/docs/dyn/androidpublisher_v2.edits.html
index 204ef08..4e601c1 100644
--- a/docs/dyn/androidpublisher_v2.edits.html
+++ b/docs/dyn/androidpublisher_v2.edits.html
@@ -85,6 +85,11 @@
<p class="firstline">Returns the apks Resource.</p>
<p class="toc_element">
+ <code><a href="androidpublisher_v2.edits.deobfuscationfiles.html">deobfuscationfiles()</a></code>
+</p>
+<p class="firstline">Returns the deobfuscationfiles Resource.</p>
+
+<p class="toc_element">
<code><a href="androidpublisher_v2.edits.details.html">details()</a></code>
</p>
<p class="firstline">Returns the details Resource.</p>
diff --git a/docs/dyn/appengine_v1beta4.apps.html b/docs/dyn/appengine_v1beta4.apps.html
index 4b7faa5..b92a097 100644
--- a/docs/dyn/appengine_v1beta4.apps.html
+++ b/docs/dyn/appengine_v1beta4.apps.html
@@ -75,6 +75,11 @@
<h1><a href="appengine_v1beta4.html">Google App Engine Admin API</a> . <a href="appengine_v1beta4.apps.html">apps</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="appengine_v1beta4.apps.locations.html">locations()</a></code>
+</p>
+<p class="firstline">Returns the locations Resource.</p>
+
+<p class="toc_element">
<code><a href="appengine_v1beta4.apps.modules.html">modules()</a></code>
</p>
<p class="firstline">Returns the modules Resource.</p>
@@ -85,33 +90,149 @@
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
+ <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the [Google Cloud Resource Manager create project topic](https://cloud.google.com/resource-manager/docs/creating-project).</p>
+<p class="toc_element">
<code><a href="#get">get(appsId, x__xgafv=None, ensureResourcesExist=None)</a></code></p>
<p class="firstline">Gets information about an application.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(appsId, body, mask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates application parameters.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="create">create(body, x__xgafv=None)</code>
+ <pre>Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the [Google Cloud Resource Manager create project topic](https://cloud.google.com/resource-manager/docs/creating-project).
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Application resource contains the top-level configuration of an App Engine application.
+ "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine. @OutputOnly
+ "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
+ "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
+ "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content. @OutputOnly
+ "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a module or version. Rules are order-dependent. @OutputOnly
+ { # Rules to match an HTTP request and dispatch that request to a module.
+ "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+ "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
+ "module": "A String", # Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: `default`.
+ },
+ ],
+ "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
+ "location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
+ "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
+ "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(appsId, x__xgafv=None, ensureResourcesExist=None)</code>
<pre>Gets information about an application.
Args:
- appsId: string, Part of `name`. Name of the application to get. For example: "apps/myapp". (required)
+ appsId: string, Part of `name`. Name of the application to get. Example: `apps/myapp`. (required)
x__xgafv: string, V1 error format.
- ensureResourcesExist: boolean, Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the `GET` operation. If specified and any resources cloud not be created, the request will fail with an error code.
+ ensureResourcesExist: boolean, Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the `GET` operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.
Returns:
An object of the form:
- { # An Application contains the top-level configuration of an App Engine application.
- "codeBucket": "A String", # A Google Cloud Storage bucket which can be used for storing files associated with an application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
- "dispatchRules": [ # HTTP path dispatch rules for requests to the app that do not explicitly target a module or version. The rules are order-dependent.
+ { # An Application resource contains the top-level configuration of an App Engine application.
+ "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine. @OutputOnly
+ "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
+ "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
+ "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content. @OutputOnly
+ "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a module or version. Rules are order-dependent. @OutputOnly
+ { # Rules to match an HTTP request and dispatch that request to a module.
+ "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+ "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
+ "module": "A String", # Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: `default`.
+ },
+ ],
+ "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
+ "location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
+ "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
+ "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(appsId, body, mask=None, x__xgafv=None)</code>
+ <pre>Updates application parameters.
+
+Args:
+ appsId: string, Part of `name`. Name of the application to update. For example: "apps/myapp". (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Application resource contains the top-level configuration of an App Engine application.
+ "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine. @OutputOnly
+ "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
+ "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
+ "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content. @OutputOnly
+ "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a module or version. Rules are order-dependent. @OutputOnly
{ # Rules to match an HTTP request and dispatch that request to a module.
- "path": "A String", # The pathname within the host. This must start with a '/'. A single '*' (glob) can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
- "domain": "A String", # The domain name to match on. Supports '*' (glob) wildcarding on the left-hand side of a '.'. If empty, all domains will be matched (the same as '*').
- "module": "A String", # The resource id of a Module in this application that should service the matched request. The Module must already exist. Example: "default".
+ "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+ "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
+ "module": "A String", # Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: `default`.
},
],
- "location": "A String", # The location from which the application will be run. Choices are "us-central" for United States and "europe-west" for European Union. Application instances will run out of data centers in the chosen location and all of the application's End User Content will be stored at rest in the chosen location. The default is "us-central".
- "name": "A String", # The full path to the application in the API. Example: "apps/myapp". @OutputOnly
- "id": "A String", # The relative name/path of the application. Example: "myapp". @OutputOnly
+ "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
+ "location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
+ "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
+ "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
+ }
+
+ mask: string, Standard field mask for the set of fields to be updated.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
diff --git a/docs/dyn/appengine_v1beta4.apps.locations.html b/docs/dyn/appengine_v1beta4.apps.locations.html
new file mode 100644
index 0000000..b2df972
--- /dev/null
+++ b/docs/dyn/appengine_v1beta4.apps.locations.html
@@ -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="appengine_v1beta4.html">Google App Engine Admin API</a> . <a href="appengine_v1beta4.apps.html">apps</a> . <a href="appengine_v1beta4.apps.locations.html">locations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(appsId, locationsId, x__xgafv=None)</a></code></p>
+<p class="firstline">Get information about a location.</p>
+<p class="toc_element">
+ <code><a href="#list">list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists information about the supported locations for this service.</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(appsId, locationsId, x__xgafv=None)</code>
+ <pre>Get information about a location.
+
+Args:
+ appsId: string, Part of `name`. Resource name for the location. (required)
+ locationsId: string, Part of `name`. See documentation of `appsId`. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A resource that represents Google Cloud Platform location.
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists information about the supported locations for this service.
+
+Args:
+ appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required)
+ pageSize: integer, The standard list page size.
+ filter: string, The standard list filter.
+ pageToken: string, The standard list page token.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The response message for LocationService.ListLocations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "locations": [ # A list of locations that matches the specified filter in the request.
+ { # A resource that represents Google Cloud Platform location.
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/appengine_v1beta4.apps.modules.html b/docs/dyn/appengine_v1beta4.apps.modules.html
index c830caa..70dbc03 100644
--- a/docs/dyn/appengine_v1beta4.apps.modules.html
+++ b/docs/dyn/appengine_v1beta4.apps.modules.html
@@ -81,10 +81,10 @@
<p class="toc_element">
<code><a href="#delete">delete(appsId, modulesId, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a module and all enclosed versions.</p>
+<p class="firstline">Deletes the specified module and all enclosed versions.</p>
<p class="toc_element">
<code><a href="#get">get(appsId, modulesId, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the current configuration of the module.</p>
+<p class="firstline">Gets the current configuration of the specified module.</p>
<p class="toc_element">
<code><a href="#list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the modules in the application.</p>
@@ -97,10 +97,10 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(appsId, modulesId, x__xgafv=None)</code>
- <pre>Deletes a module and all enclosed versions.
+ <pre>Deletes the specified module and all enclosed versions.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/modules/default". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default`. (required)
modulesId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
@@ -109,46 +109,46 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping above, the `name` should have the format of `operations/some/unique/name`.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(appsId, modulesId, x__xgafv=None)</code>
- <pre>Gets the current configuration of the module.
+ <pre>Gets the current configuration of the specified module.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/modules/default". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default`. (required)
modulesId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
- { # A module is a component of an application that provides a single service or configuration. A module has a collection of versions that define a specific set of code used to implement the functionality of that module.
- "split": { # Configuration for traffic splitting for versions within a single module. Traffic splitting allows traffic directed to the module to be assigned to one of several versions in a fractional way, enabling experiments and canarying new builds, for example. # A mapping that defines fractional HTTP traffic diversion to different versions within the module.
- "shardBy": "A String", # Which mechanism should be used as a selector when choosing a version to send a request to. The traffic selection algorithm will be stable for either type until allocations are changed.
- "allocations": { # Mapping from module version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated in this field may not be deleted until the module is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.
+ { # A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.
+ "split": { # Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the module.
+ "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
+ "allocations": { # Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
"a_key": 3.14,
},
},
- "name": "A String", # The full path to the Module resource in the API. Example: "apps/myapp/modules/default" @OutputOnly
- "id": "A String", # The relative name/path of the module within the application. Example: "default" @OutputOnly
+ "name": "A String", # Full path to the Module resource in the API. Example: `apps/myapp/modules/default`. @OutputOnly
+ "id": "A String", # Relative name of the module within the application. Example: `default`. @OutputOnly
}</pre>
</div>
@@ -157,7 +157,7 @@
<pre>Lists all the modules in the application.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp`. (required)
pageSize: integer, Maximum results to return per page.
pageToken: string, Continuation token for fetching the next page of results.
x__xgafv: string, V1 error format.
@@ -168,15 +168,15 @@
{ # Response message for `Modules.ListModules`.
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
"modules": [ # The modules belonging to the requested application.
- { # A module is a component of an application that provides a single service or configuration. A module has a collection of versions that define a specific set of code used to implement the functionality of that module.
- "split": { # Configuration for traffic splitting for versions within a single module. Traffic splitting allows traffic directed to the module to be assigned to one of several versions in a fractional way, enabling experiments and canarying new builds, for example. # A mapping that defines fractional HTTP traffic diversion to different versions within the module.
- "shardBy": "A String", # Which mechanism should be used as a selector when choosing a version to send a request to. The traffic selection algorithm will be stable for either type until allocations are changed.
- "allocations": { # Mapping from module version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated in this field may not be deleted until the module is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.
+ { # A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.
+ "split": { # Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the module.
+ "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
+ "allocations": { # Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
"a_key": 3.14,
},
},
- "name": "A String", # The full path to the Module resource in the API. Example: "apps/myapp/modules/default" @OutputOnly
- "id": "A String", # The relative name/path of the module within the application. Example: "default" @OutputOnly
+ "name": "A String", # Full path to the Module resource in the API. Example: `apps/myapp/modules/default`. @OutputOnly
+ "id": "A String", # Relative name of the module within the application. Example: `default`. @OutputOnly
},
],
}</pre>
@@ -201,23 +201,23 @@
<pre>Updates the configuration of the specified module.
Args:
- appsId: string, Part of `name`. Name of the resource to update. For example: "apps/myapp/modules/default". (required)
+ appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/modules/default`. (required)
modulesId: string, Part of `name`. See documentation of `appsId`. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # A module is a component of an application that provides a single service or configuration. A module has a collection of versions that define a specific set of code used to implement the functionality of that module.
- "split": { # Configuration for traffic splitting for versions within a single module. Traffic splitting allows traffic directed to the module to be assigned to one of several versions in a fractional way, enabling experiments and canarying new builds, for example. # A mapping that defines fractional HTTP traffic diversion to different versions within the module.
- "shardBy": "A String", # Which mechanism should be used as a selector when choosing a version to send a request to. The traffic selection algorithm will be stable for either type until allocations are changed.
- "allocations": { # Mapping from module version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated in this field may not be deleted until the module is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.
+{ # A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.
+ "split": { # Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the module.
+ "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
+ "allocations": { # Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
"a_key": 3.14,
},
},
- "name": "A String", # The full path to the Module resource in the API. Example: "apps/myapp/modules/default" @OutputOnly
- "id": "A String", # The relative name/path of the module within the application. Example: "default" @OutputOnly
+ "name": "A String", # Full path to the Module resource in the API. Example: `apps/myapp/modules/default`. @OutputOnly
+ "id": "A String", # Relative name of the module within the application. Example: `default`. @OutputOnly
}
- migrateTraffic: boolean, Whether to use Traffic Migration to shift traffic gradually. Traffic can only be migrated from a single version to another single version.
+ migrateTraffic: boolean, Set to `true` to gradually shift traffic from one version to another single version. By default, traffic is shifted immediately. For gradual traffic migration, the target version must be located within instances that are configured for both [warmup requests](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and [automatic scaling](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the [`shardBy`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see [Migrating and Splitting Traffic](https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
mask: string, Standard field mask for the set of fields to be updated.
x__xgafv: string, V1 error format.
@@ -226,21 +226,21 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping above, the `name` should have the format of `operations/some/unique/name`.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
diff --git a/docs/dyn/appengine_v1beta4.apps.modules.versions.html b/docs/dyn/appengine_v1beta4.apps.modules.versions.html
index 35670db..223561d 100644
--- a/docs/dyn/appengine_v1beta4.apps.modules.versions.html
+++ b/docs/dyn/appengine_v1beta4.apps.modules.versions.html
@@ -75,169 +75,193 @@
<h1><a href="appengine_v1beta4.html">Google App Engine Admin API</a> . <a href="appengine_v1beta4.apps.html">apps</a> . <a href="appengine_v1beta4.apps.modules.html">modules</a> . <a href="appengine_v1beta4.apps.modules.versions.html">versions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="appengine_v1beta4.apps.modules.versions.instances.html">instances()</a></code>
+</p>
+<p class="firstline">Returns the instances Resource.</p>
+
+<p class="toc_element">
<code><a href="#create">create(appsId, modulesId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Deploys new code and resource files to a version.</p>
+<p class="firstline">Deploys code and resource files to a new version.</p>
<p class="toc_element">
<code><a href="#delete">delete(appsId, modulesId, versionsId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing version.</p>
<p class="toc_element">
<code><a href="#get">get(appsId, modulesId, versionsId, x__xgafv=None, view=None)</a></code></p>
-<p class="firstline">Gets application deployment information.</p>
+<p class="firstline">Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.</p>
<p class="toc_element">
<code><a href="#list">list(appsId, modulesId, pageSize=None, pageToken=None, x__xgafv=None, view=None)</a></code></p>
<p class="firstline">Lists the versions of a module.</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(appsId, modulesId, versionsId, body, mask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(appsId, modulesId, body, x__xgafv=None)</code>
- <pre>Deploys new code and resource files to a version.
+ <pre>Deploys code and resource files to a new version.
Args:
- appsId: string, Part of `name`. Name of the resource to update. For example: "apps/myapp/modules/default". (required)
+ appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/modules/default`. (required)
modulesId: string, Part of `name`. See documentation of `appsId`. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # A Version is a specific set of source code and configuration files deployed to a module.
+{ # A Version resource is a specific set of source code and configuration files that are deployed into a module.
"basicScaling": { # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
- "idleTimeout": "A String", # The instance will be shut down this amount of time after receiving its last request.
- "maxInstances": 42, # The maximum number of instances for App Engine to create for this version.
+ "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
+ "maxInstances": 42, # Maximum number of instances to create for this version.
},
- "betaSettings": { # Beta settings supplied to the application via metadata.
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
"a_key": "A String",
},
- "vm": True or False, # Whether to deploy this app in a VM container (deprecated, use "env":"2").
- "instanceClass": "A String", # The frontend instance class to use to run this app. Valid values are `[F1, F2, F4, F4_1G]`. Default: "F1"
- "errorHandlers": [ # Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A custom static error page to be served when an error occurs.
- "errorCode": "A String", # The error condition this handler applies to.
- "mimeType": "A String", # MIME type of file. If unspecified, "text/html" is assumed.
+ "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
+ "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
+ "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
+ { # Custom static error page to be served when an error occurs.
+ "errorCode": "A String", # Error condition this handler applies to.
+ "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
"staticFile": "A String", # Static file content to be served for this error.
},
],
- "id": "A String", # The relative name/path of the Version within the module. Example: "v1". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used.
- "apiConfig": { # API Serving configuration for Cloud Endpoints. # Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
+ "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
"url": "A String", # URL to serve the endpoint at.
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "login": "A String", # What level of login is required to access this resource. Default is "optional".
- "script": "A String", # Specifies the path to the script from the application root directory.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
+ "script": "A String", # Path to the script from the application root directory.
},
- "threadsafe": True or False, # If true, multiple requests can be dispatched to the app at once.
- "healthCheck": { # Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances. # Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "restartThreshold": 42, # The number of consecutive failed health checks before an instance is restarted.
- "checkInterval": "A String", # The interval between health checks.
- "unhealthyThreshold": 42, # The number of consecutive failed health checks before removing traffic.
- "healthyThreshold": 42, # The number of consecutive successful health checks before receiving traffic.
- "host": "A String", # The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)
- "timeout": "A String", # The amount of time before the health check is considered failed.
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
+ "checkInterval": "A String", # Interval between health checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
+ "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
+ "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
- "defaultExpiration": "A String", # The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "libraries": [ # Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A Python runtime third-party library required by the application.
- "version": "A String", # The version of the library to select, or "latest".
- "name": "A String", # The name of the library, e.g. "PIL" or "django".
+ "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
+ "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
+ { # Third-party Python runtime library that is required by the application.
+ "version": "A String", # Version of the library to select, or "latest".
+ "name": "A String", # Name of the library. Example: "django".
},
],
- "deployer": "A String", # The email address of the user who created this version. @OutputOnly
- "env": "A String", # The App Engine execution environment to use for this version. Default: "1"
- "automaticScaling": { # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics. # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
- "minPendingLatency": "A String", # The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "maxPendingLatency": "A String", # The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "maxIdleInstances": 42, # The maximum number of idle instances that App Engine should maintain for this version.
- "minIdleInstances": 42, # The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a module, since other versions are not expected to receive significant traffic.
- "coolDownPeriod": "A String", # The amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Applies only to the VM runtime.
- "maxTotalInstances": 42, # Max number of instances that App Engine should start to handle requests.
- "maxConcurrentRequests": 42, # The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.
- "minTotalInstances": 42, # Minimum number of instances that App Engine should maintain.
+ "deployer": "A String", # Email address of the user who created this version. @OutputOnly
+ "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
+ "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
+ "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
+ "targetReceivedBytesPerSec": 42, # Target bytes received per second.
+ "targetSentBytesPerSec": 42, # Target bytes sent per second.
+ "targetReceivedPacketsPerSec": 42, # Target packets received per second.
+ "targetSentPacketsPerSec": 42, # Target packets sent per second.
+ },
+ "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
+ "targetWriteOpsPerSec": 42, # Target ops written per second.
+ "targetReadBytesPerSec": 42, # Target bytes read per second.
+ "targetReadOpsPerSec": 42, # Target ops read per second.
+ "targetWriteBytesPerSec": 42, # Target bytes written per second.
+ },
+ "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
+ "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
+ "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
+ "targetConcurrentRequests": 42, # Target number of concurrent requests.
+ "targetRequestCountPerSec": 42, # Target requests per second.
+ },
+ "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
+ "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
+ "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
+ "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
"cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target (0-1) CPU utilization ratio to maintain when scaling.
- "aggregationWindowLength": "A String", # The period of time over which CPU utilization is calculated.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
},
},
- "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
"a_key": "A String",
},
- "resources": { # Used to specify how many machine resources an app version needs. # Used to specify how many machine resources an app version needs (for VM runtimes only).
- "diskGb": 3.14, # How much disk size, in GB, an app version needs.
- "cpu": 3.14, # How many CPU cores an app version needs.
- "memoryGb": 3.14, # How much memory, in GB, an app version needs.
+ "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
+ "diskGb": 3.14, # Disk size (GB) needed.
+ "cpu": 3.14, # Number of CPU cores needed.
+ "memoryGb": 3.14, # Memory (GB) needed.
},
"manualScaling": { # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
- "instances": 42, # The number of instances to assign to the module at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
+ "instances": 42, # Number of instances to assign to the module at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
},
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "files": { # A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
- "a_key": { # A single source file which is part of the application to be deployed.
- "mimeType": "A String", # The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used.
- "sourceUrl": "A String", # The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage.
- "sha1Sum": "A String", # The SHA1 (160 bits) hash of the file in hex.
+ "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
+ "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
+ "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
+ "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
+ "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
- "sourceReferences": [ # The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.
- { # A reference to a particular snapshot of the source tree used to build and deploy the application.
- "revisionId": "A String", # The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
- "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
+ "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
+ { # Reference to a particular snapshot of the source tree used to build and deploy the application.
+ "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
+ "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # A Docker (container) image which should be used to start the application. # If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime.
- "image": "A String", # Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@digest
+ "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
- "network": { # Used to specify extra network settings (for VM runtimes only). # Used to specify extra network settings (for VM runtimes only).
- "instanceTag": "A String", # A tag to apply to the VM instance during creation.
- "forwardedPorts": [ # A list of ports (or port pairs) to forward from the VM into the app container.
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
"A String",
],
- "name": "A String", # The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named "default" will be used. (The short name should be specified, not the resource path.)
+ "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
},
- "nobuildFilesRegex": "A String", # Go only. Files that match this pattern will not be built into the app. May only be set on create requests.
- "name": "A String", # The full path to the Version resource in the API. Example: "apps/myapp/modules/default/versions/v1". @OutputOnly
- "handlers": [ # An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/modules/default/versions/v1`. @OutputOnly
+ "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
+ { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
"staticDirectory": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files. # Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
- "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
+ "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
- "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
- "directory": "A String", # The path to the directory containing the static files, from the application root directory. Everything after the end of the matched url pattern is appended to static_dir to form the full path to the requested file.
- "requireMatchingFile": True or False, # If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL.
- "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached.
+ "directory": "A String", # Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to `static_dir` to form the full path to the requested file.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
},
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "urlRegex": "A String", # A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required.
- "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches the URL pattern.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
+ "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
- "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
- "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
- "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
- "requireMatchingFile": True or False, # If true, this [UrlMap][google.appengine.v1beta4.UrlMap] entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next [UrlMap][google.appengine.v1beta4.UrlMap] that matches the requested URL.
- "uploadPathRegex": "A String", # A regular expression that matches the file paths for all files that will be referenced by this handler.
- "path": "A String", # The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
+ "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
+ "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
},
- "apiEndpoint": { # Use Google Cloud Endpoints to handle requests. # Use API Endpoints to handle requests.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
- "login": "A String", # What level of login is required to access this resource.
- "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. A `302` is used by default.
+ "login": "A String", # Level of login required to access this resource.
+ "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
},
],
- "creationTime": "A String", # Creation time of this version. This will be between the start and end times of the operation that creates this version. @OutputOnly
- "servingStatus": "A String", # The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.
- "runtime": "A String", # The desired runtime. Values can include python27, java7, go, etc.
+ "creationTime": "A String", # Time that this version was created. @OutputOnly
+ "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
+ "runtime": "A String", # Desired runtime. Example: `python27`.
}
x__xgafv: string, V1 error format.
@@ -247,21 +271,21 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping above, the `name` should have the format of `operations/some/unique/name`.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
@@ -271,7 +295,7 @@
<pre>Deletes an existing version.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/modules/default/versions/v1". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1`. (required)
modulesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
@@ -281,31 +305,31 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping above, the `name` should have the format of `operations/some/unique/name`.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(appsId, modulesId, versionsId, x__xgafv=None, view=None)</code>
- <pre>Gets application deployment information.
+ <pre>Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/modules/default/versions/v1". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1`. (required)
modulesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
@@ -314,144 +338,160 @@
Returns:
An object of the form:
- { # A Version is a specific set of source code and configuration files deployed to a module.
+ { # A Version resource is a specific set of source code and configuration files that are deployed into a module.
"basicScaling": { # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
- "idleTimeout": "A String", # The instance will be shut down this amount of time after receiving its last request.
- "maxInstances": 42, # The maximum number of instances for App Engine to create for this version.
+ "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
+ "maxInstances": 42, # Maximum number of instances to create for this version.
},
- "betaSettings": { # Beta settings supplied to the application via metadata.
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
"a_key": "A String",
},
- "vm": True or False, # Whether to deploy this app in a VM container (deprecated, use "env":"2").
- "instanceClass": "A String", # The frontend instance class to use to run this app. Valid values are `[F1, F2, F4, F4_1G]`. Default: "F1"
- "errorHandlers": [ # Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A custom static error page to be served when an error occurs.
- "errorCode": "A String", # The error condition this handler applies to.
- "mimeType": "A String", # MIME type of file. If unspecified, "text/html" is assumed.
+ "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
+ "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
+ "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
+ { # Custom static error page to be served when an error occurs.
+ "errorCode": "A String", # Error condition this handler applies to.
+ "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
"staticFile": "A String", # Static file content to be served for this error.
},
],
- "id": "A String", # The relative name/path of the Version within the module. Example: "v1". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used.
- "apiConfig": { # API Serving configuration for Cloud Endpoints. # Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
+ "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
"url": "A String", # URL to serve the endpoint at.
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "login": "A String", # What level of login is required to access this resource. Default is "optional".
- "script": "A String", # Specifies the path to the script from the application root directory.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
+ "script": "A String", # Path to the script from the application root directory.
},
- "threadsafe": True or False, # If true, multiple requests can be dispatched to the app at once.
- "healthCheck": { # Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances. # Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "restartThreshold": 42, # The number of consecutive failed health checks before an instance is restarted.
- "checkInterval": "A String", # The interval between health checks.
- "unhealthyThreshold": 42, # The number of consecutive failed health checks before removing traffic.
- "healthyThreshold": 42, # The number of consecutive successful health checks before receiving traffic.
- "host": "A String", # The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)
- "timeout": "A String", # The amount of time before the health check is considered failed.
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
+ "checkInterval": "A String", # Interval between health checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
+ "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
+ "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
- "defaultExpiration": "A String", # The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "libraries": [ # Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A Python runtime third-party library required by the application.
- "version": "A String", # The version of the library to select, or "latest".
- "name": "A String", # The name of the library, e.g. "PIL" or "django".
+ "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
+ "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
+ { # Third-party Python runtime library that is required by the application.
+ "version": "A String", # Version of the library to select, or "latest".
+ "name": "A String", # Name of the library. Example: "django".
},
],
- "deployer": "A String", # The email address of the user who created this version. @OutputOnly
- "env": "A String", # The App Engine execution environment to use for this version. Default: "1"
- "automaticScaling": { # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics. # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
- "minPendingLatency": "A String", # The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "maxPendingLatency": "A String", # The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "maxIdleInstances": 42, # The maximum number of idle instances that App Engine should maintain for this version.
- "minIdleInstances": 42, # The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a module, since other versions are not expected to receive significant traffic.
- "coolDownPeriod": "A String", # The amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Applies only to the VM runtime.
- "maxTotalInstances": 42, # Max number of instances that App Engine should start to handle requests.
- "maxConcurrentRequests": 42, # The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.
- "minTotalInstances": 42, # Minimum number of instances that App Engine should maintain.
+ "deployer": "A String", # Email address of the user who created this version. @OutputOnly
+ "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
+ "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
+ "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
+ "targetReceivedBytesPerSec": 42, # Target bytes received per second.
+ "targetSentBytesPerSec": 42, # Target bytes sent per second.
+ "targetReceivedPacketsPerSec": 42, # Target packets received per second.
+ "targetSentPacketsPerSec": 42, # Target packets sent per second.
+ },
+ "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
+ "targetWriteOpsPerSec": 42, # Target ops written per second.
+ "targetReadBytesPerSec": 42, # Target bytes read per second.
+ "targetReadOpsPerSec": 42, # Target ops read per second.
+ "targetWriteBytesPerSec": 42, # Target bytes written per second.
+ },
+ "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
+ "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
+ "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
+ "targetConcurrentRequests": 42, # Target number of concurrent requests.
+ "targetRequestCountPerSec": 42, # Target requests per second.
+ },
+ "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
+ "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
+ "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
+ "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
"cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target (0-1) CPU utilization ratio to maintain when scaling.
- "aggregationWindowLength": "A String", # The period of time over which CPU utilization is calculated.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
},
},
- "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
"a_key": "A String",
},
- "resources": { # Used to specify how many machine resources an app version needs. # Used to specify how many machine resources an app version needs (for VM runtimes only).
- "diskGb": 3.14, # How much disk size, in GB, an app version needs.
- "cpu": 3.14, # How many CPU cores an app version needs.
- "memoryGb": 3.14, # How much memory, in GB, an app version needs.
+ "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
+ "diskGb": 3.14, # Disk size (GB) needed.
+ "cpu": 3.14, # Number of CPU cores needed.
+ "memoryGb": 3.14, # Memory (GB) needed.
},
"manualScaling": { # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
- "instances": 42, # The number of instances to assign to the module at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
+ "instances": 42, # Number of instances to assign to the module at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
},
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "files": { # A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
- "a_key": { # A single source file which is part of the application to be deployed.
- "mimeType": "A String", # The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used.
- "sourceUrl": "A String", # The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage.
- "sha1Sum": "A String", # The SHA1 (160 bits) hash of the file in hex.
+ "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
+ "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
+ "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
+ "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
+ "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
- "sourceReferences": [ # The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.
- { # A reference to a particular snapshot of the source tree used to build and deploy the application.
- "revisionId": "A String", # The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
- "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
+ "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
+ { # Reference to a particular snapshot of the source tree used to build and deploy the application.
+ "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
+ "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # A Docker (container) image which should be used to start the application. # If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime.
- "image": "A String", # Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@digest
+ "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
- "network": { # Used to specify extra network settings (for VM runtimes only). # Used to specify extra network settings (for VM runtimes only).
- "instanceTag": "A String", # A tag to apply to the VM instance during creation.
- "forwardedPorts": [ # A list of ports (or port pairs) to forward from the VM into the app container.
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
"A String",
],
- "name": "A String", # The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named "default" will be used. (The short name should be specified, not the resource path.)
+ "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
},
- "nobuildFilesRegex": "A String", # Go only. Files that match this pattern will not be built into the app. May only be set on create requests.
- "name": "A String", # The full path to the Version resource in the API. Example: "apps/myapp/modules/default/versions/v1". @OutputOnly
- "handlers": [ # An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/modules/default/versions/v1`. @OutputOnly
+ "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
+ { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
"staticDirectory": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files. # Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
- "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
+ "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
- "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
- "directory": "A String", # The path to the directory containing the static files, from the application root directory. Everything after the end of the matched url pattern is appended to static_dir to form the full path to the requested file.
- "requireMatchingFile": True or False, # If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL.
- "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached.
+ "directory": "A String", # Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to `static_dir` to form the full path to the requested file.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
},
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "urlRegex": "A String", # A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required.
- "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches the URL pattern.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
+ "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
- "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
- "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
- "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
- "requireMatchingFile": True or False, # If true, this [UrlMap][google.appengine.v1beta4.UrlMap] entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next [UrlMap][google.appengine.v1beta4.UrlMap] that matches the requested URL.
- "uploadPathRegex": "A String", # A regular expression that matches the file paths for all files that will be referenced by this handler.
- "path": "A String", # The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
+ "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
+ "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
},
- "apiEndpoint": { # Use Google Cloud Endpoints to handle requests. # Use API Endpoints to handle requests.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
- "login": "A String", # What level of login is required to access this resource.
- "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. A `302` is used by default.
+ "login": "A String", # Level of login required to access this resource.
+ "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
},
],
- "creationTime": "A String", # Creation time of this version. This will be between the start and end times of the operation that creates this version. @OutputOnly
- "servingStatus": "A String", # The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.
- "runtime": "A String", # The desired runtime. Values can include python27, java7, go, etc.
+ "creationTime": "A String", # Time that this version was created. @OutputOnly
+ "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
+ "runtime": "A String", # Desired runtime. Example: `python27`.
}</pre>
</div>
@@ -460,7 +500,7 @@
<pre>Lists the versions of a module.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/modules/default". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default`. (required)
modulesId: string, Part of `name`. See documentation of `appsId`. (required)
pageSize: integer, Maximum results to return per page.
pageToken: string, Continuation token for fetching the next page of results.
@@ -472,145 +512,161 @@
{ # Response message for `Versions.ListVersions`.
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
- "versions": [ # The versions belonging to the requested application module.
- { # A Version is a specific set of source code and configuration files deployed to a module.
+ "versions": [ # The versions belonging to the requested module.
+ { # A Version resource is a specific set of source code and configuration files that are deployed into a module.
"basicScaling": { # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
- "idleTimeout": "A String", # The instance will be shut down this amount of time after receiving its last request.
- "maxInstances": 42, # The maximum number of instances for App Engine to create for this version.
+ "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
+ "maxInstances": 42, # Maximum number of instances to create for this version.
},
- "betaSettings": { # Beta settings supplied to the application via metadata.
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
"a_key": "A String",
},
- "vm": True or False, # Whether to deploy this app in a VM container (deprecated, use "env":"2").
- "instanceClass": "A String", # The frontend instance class to use to run this app. Valid values are `[F1, F2, F4, F4_1G]`. Default: "F1"
- "errorHandlers": [ # Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A custom static error page to be served when an error occurs.
- "errorCode": "A String", # The error condition this handler applies to.
- "mimeType": "A String", # MIME type of file. If unspecified, "text/html" is assumed.
+ "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
+ "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
+ "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
+ { # Custom static error page to be served when an error occurs.
+ "errorCode": "A String", # Error condition this handler applies to.
+ "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
"staticFile": "A String", # Static file content to be served for this error.
},
],
- "id": "A String", # The relative name/path of the Version within the module. Example: "v1". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used.
- "apiConfig": { # API Serving configuration for Cloud Endpoints. # Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
+ "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
"url": "A String", # URL to serve the endpoint at.
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "login": "A String", # What level of login is required to access this resource. Default is "optional".
- "script": "A String", # Specifies the path to the script from the application root directory.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
+ "script": "A String", # Path to the script from the application root directory.
},
- "threadsafe": True or False, # If true, multiple requests can be dispatched to the app at once.
- "healthCheck": { # Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances. # Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "restartThreshold": 42, # The number of consecutive failed health checks before an instance is restarted.
- "checkInterval": "A String", # The interval between health checks.
- "unhealthyThreshold": 42, # The number of consecutive failed health checks before removing traffic.
- "healthyThreshold": 42, # The number of consecutive successful health checks before receiving traffic.
- "host": "A String", # The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)
- "timeout": "A String", # The amount of time before the health check is considered failed.
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
+ "checkInterval": "A String", # Interval between health checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
+ "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
+ "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
- "defaultExpiration": "A String", # The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "libraries": [ # Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A Python runtime third-party library required by the application.
- "version": "A String", # The version of the library to select, or "latest".
- "name": "A String", # The name of the library, e.g. "PIL" or "django".
+ "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
+ "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
+ { # Third-party Python runtime library that is required by the application.
+ "version": "A String", # Version of the library to select, or "latest".
+ "name": "A String", # Name of the library. Example: "django".
},
],
- "deployer": "A String", # The email address of the user who created this version. @OutputOnly
- "env": "A String", # The App Engine execution environment to use for this version. Default: "1"
- "automaticScaling": { # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics. # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
- "minPendingLatency": "A String", # The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "maxPendingLatency": "A String", # The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "maxIdleInstances": 42, # The maximum number of idle instances that App Engine should maintain for this version.
- "minIdleInstances": 42, # The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a module, since other versions are not expected to receive significant traffic.
- "coolDownPeriod": "A String", # The amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Applies only to the VM runtime.
- "maxTotalInstances": 42, # Max number of instances that App Engine should start to handle requests.
- "maxConcurrentRequests": 42, # The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.
- "minTotalInstances": 42, # Minimum number of instances that App Engine should maintain.
+ "deployer": "A String", # Email address of the user who created this version. @OutputOnly
+ "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
+ "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
+ "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
+ "targetReceivedBytesPerSec": 42, # Target bytes received per second.
+ "targetSentBytesPerSec": 42, # Target bytes sent per second.
+ "targetReceivedPacketsPerSec": 42, # Target packets received per second.
+ "targetSentPacketsPerSec": 42, # Target packets sent per second.
+ },
+ "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
+ "targetWriteOpsPerSec": 42, # Target ops written per second.
+ "targetReadBytesPerSec": 42, # Target bytes read per second.
+ "targetReadOpsPerSec": 42, # Target ops read per second.
+ "targetWriteBytesPerSec": 42, # Target bytes written per second.
+ },
+ "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
+ "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
+ "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
+ "targetConcurrentRequests": 42, # Target number of concurrent requests.
+ "targetRequestCountPerSec": 42, # Target requests per second.
+ },
+ "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
+ "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
+ "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
+ "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
"cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target (0-1) CPU utilization ratio to maintain when scaling.
- "aggregationWindowLength": "A String", # The period of time over which CPU utilization is calculated.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
},
},
- "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
"a_key": "A String",
},
- "resources": { # Used to specify how many machine resources an app version needs. # Used to specify how many machine resources an app version needs (for VM runtimes only).
- "diskGb": 3.14, # How much disk size, in GB, an app version needs.
- "cpu": 3.14, # How many CPU cores an app version needs.
- "memoryGb": 3.14, # How much memory, in GB, an app version needs.
+ "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
+ "diskGb": 3.14, # Disk size (GB) needed.
+ "cpu": 3.14, # Number of CPU cores needed.
+ "memoryGb": 3.14, # Memory (GB) needed.
},
"manualScaling": { # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
- "instances": 42, # The number of instances to assign to the module at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
+ "instances": 42, # Number of instances to assign to the module at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
},
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "files": { # A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
- "a_key": { # A single source file which is part of the application to be deployed.
- "mimeType": "A String", # The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used.
- "sourceUrl": "A String", # The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage.
- "sha1Sum": "A String", # The SHA1 (160 bits) hash of the file in hex.
+ "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
+ "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
+ "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
+ "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
+ "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
- "sourceReferences": [ # The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.
- { # A reference to a particular snapshot of the source tree used to build and deploy the application.
- "revisionId": "A String", # The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
- "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
+ "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
+ { # Reference to a particular snapshot of the source tree used to build and deploy the application.
+ "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
+ "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # A Docker (container) image which should be used to start the application. # If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime.
- "image": "A String", # Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@digest
+ "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
- "network": { # Used to specify extra network settings (for VM runtimes only). # Used to specify extra network settings (for VM runtimes only).
- "instanceTag": "A String", # A tag to apply to the VM instance during creation.
- "forwardedPorts": [ # A list of ports (or port pairs) to forward from the VM into the app container.
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
"A String",
],
- "name": "A String", # The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named "default" will be used. (The short name should be specified, not the resource path.)
+ "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
},
- "nobuildFilesRegex": "A String", # Go only. Files that match this pattern will not be built into the app. May only be set on create requests.
- "name": "A String", # The full path to the Version resource in the API. Example: "apps/myapp/modules/default/versions/v1". @OutputOnly
- "handlers": [ # An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/modules/default/versions/v1`. @OutputOnly
+ "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
+ { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
"staticDirectory": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files. # Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
- "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
+ "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
- "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
- "directory": "A String", # The path to the directory containing the static files, from the application root directory. Everything after the end of the matched url pattern is appended to static_dir to form the full path to the requested file.
- "requireMatchingFile": True or False, # If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL.
- "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached.
+ "directory": "A String", # Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to `static_dir` to form the full path to the requested file.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
},
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "urlRegex": "A String", # A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required.
- "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches the URL pattern.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
+ "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
- "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
- "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
- "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
- "requireMatchingFile": True or False, # If true, this [UrlMap][google.appengine.v1beta4.UrlMap] entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next [UrlMap][google.appengine.v1beta4.UrlMap] that matches the requested URL.
- "uploadPathRegex": "A String", # A regular expression that matches the file paths for all files that will be referenced by this handler.
- "path": "A String", # The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
+ "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
+ "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
},
- "apiEndpoint": { # Use Google Cloud Endpoints to handle requests. # Use API Endpoints to handle requests.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
- "login": "A String", # What level of login is required to access this resource.
- "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. A `302` is used by default.
+ "login": "A String", # Level of login required to access this resource.
+ "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
},
],
- "creationTime": "A String", # Creation time of this version. This will be between the start and end times of the operation that creates this version. @OutputOnly
- "servingStatus": "A String", # The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.
- "runtime": "A String", # The desired runtime. Values can include python27, java7, go, etc.
+ "creationTime": "A String", # Time that this version was created. @OutputOnly
+ "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
+ "runtime": "A String", # Desired runtime. Example: `python27`.
},
],
}</pre>
@@ -630,4 +686,198 @@
</pre>
</div>
+<div class="method">
+ <code class="details" id="patch">patch(appsId, modulesId, versionsId, body, mask=None, x__xgafv=None)</code>
+ <pre>Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/modules/default/versions/1`. (required)
+ modulesId: string, Part of `name`. See documentation of `appsId`. (required)
+ versionsId: string, Part of `name`. See documentation of `appsId`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A Version resource is a specific set of source code and configuration files that are deployed into a module.
+ "basicScaling": { # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
+ "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
+ "maxInstances": 42, # Maximum number of instances to create for this version.
+ },
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
+ "a_key": "A String",
+ },
+ "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
+ "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
+ "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
+ { # Custom static error page to be served when an error occurs.
+ "errorCode": "A String", # Error condition this handler applies to.
+ "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
+ "staticFile": "A String", # Static file content to be served for this error.
+ },
+ ],
+ "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
+ "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
+ "url": "A String", # URL to serve the endpoint at.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
+ "script": "A String", # Path to the script from the application root directory.
+ },
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
+ "checkInterval": "A String", # Interval between health checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
+ "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
+ "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the health check is considered failed.
+ "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
+ },
+ "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
+ "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
+ { # Third-party Python runtime library that is required by the application.
+ "version": "A String", # Version of the library to select, or "latest".
+ "name": "A String", # Name of the library. Example: "django".
+ },
+ ],
+ "deployer": "A String", # Email address of the user who created this version. @OutputOnly
+ "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
+ "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
+ "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
+ "targetReceivedBytesPerSec": 42, # Target bytes received per second.
+ "targetSentBytesPerSec": 42, # Target bytes sent per second.
+ "targetReceivedPacketsPerSec": 42, # Target packets received per second.
+ "targetSentPacketsPerSec": 42, # Target packets sent per second.
+ },
+ "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
+ "targetWriteOpsPerSec": 42, # Target ops written per second.
+ "targetReadBytesPerSec": 42, # Target bytes read per second.
+ "targetReadOpsPerSec": 42, # Target ops read per second.
+ "targetWriteBytesPerSec": 42, # Target bytes written per second.
+ },
+ "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
+ "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
+ "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
+ "targetConcurrentRequests": 42, # Target number of concurrent requests.
+ "targetRequestCountPerSec": 42, # Target requests per second.
+ },
+ "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
+ "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
+ "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
+ "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
+ "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
+ },
+ },
+ "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
+ "a_key": "A String",
+ },
+ "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
+ "diskGb": 3.14, # Disk size (GB) needed.
+ "cpu": 3.14, # Number of CPU cores needed.
+ "memoryGb": 3.14, # Memory (GB) needed.
+ },
+ "manualScaling": { # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
+ "instances": 42, # Number of instances to assign to the module at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
+ },
+ "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
+ "A String",
+ ],
+ "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
+ "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
+ "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
+ "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
+ "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
+ },
+ },
+ "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
+ { # Reference to a particular snapshot of the source tree used to build and deploy the application.
+ "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
+ "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
+ },
+ ],
+ "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ },
+ },
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
+ "A String",
+ ],
+ "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
+ },
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/modules/default/versions/v1`. @OutputOnly
+ "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
+ { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
+ "staticDirectory": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files. # Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
+ "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.
+ "httpHeaders": { # HTTP headers to use for all responses from these URLs.
+ "a_key": "A String",
+ },
+ "expiration": "A String", # Time a static file served by this handler should be cached.
+ "directory": "A String", # Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to `static_dir` to form the full path to the requested file.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ },
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
+ "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
+ "scriptPath": "A String", # Path to the script from the application root directory.
+ },
+ "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
+ "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
+ "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
+ "httpHeaders": { # HTTP headers to use for all responses from these URLs.
+ "a_key": "A String",
+ },
+ },
+ "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
+ "scriptPath": "A String", # Path to the script from the application root directory.
+ },
+ "login": "A String", # Level of login required to access this resource.
+ "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
+ },
+ ],
+ "creationTime": "A String", # Time that this version was created. @OutputOnly
+ "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
+ "runtime": "A String", # Desired runtime. Example: `python27`.
+ }
+
+ mask: string, Standard field mask for the set of fields to be updated.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/appengine_v1beta4.apps.modules.versions.instances.html b/docs/dyn/appengine_v1beta4.apps.modules.versions.instances.html
new file mode 100644
index 0000000..a21db3f
--- /dev/null
+++ b/docs/dyn/appengine_v1beta4.apps.modules.versions.instances.html
@@ -0,0 +1,255 @@
+<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="appengine_v1beta4.html">Google App Engine Admin API</a> . <a href="appengine_v1beta4.apps.html">apps</a> . <a href="appengine_v1beta4.apps.modules.html">modules</a> . <a href="appengine_v1beta4.apps.modules.versions.html">versions</a> . <a href="appengine_v1beta4.apps.modules.versions.instances.html">instances</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#debug">debug(appsId, modulesId, versionsId, instancesId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</a></code></p>
+<p class="firstline">Stops a running instance.</p>
+<p class="toc_element">
+ <code><a href="#get">get(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets instance information.</p>
+<p class="toc_element">
+ <code><a href="#list">list(appsId, modulesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists the instances of a version.</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="debug">debug(appsId, modulesId, versionsId, instancesId, body, x__xgafv=None)</code>
+ <pre>Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. (required)
+ modulesId: string, Part of `name`. See documentation of `appsId`. (required)
+ versionsId: string, Part of `name`. See documentation of `appsId`. (required)
+ instancesId: string, Part of `name`. See documentation of `appsId`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request message for `Instances.DebugInstance`.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</code>
+ <pre>Stops a running instance.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. (required)
+ modulesId: string, Part of `name`. See documentation of `appsId`. (required)
+ versionsId: string, Part of `name`. See documentation of `appsId`. (required)
+ instancesId: string, Part of `name`. See documentation of `appsId`. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</code>
+ <pre>Gets instance information.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. (required)
+ modulesId: string, Part of `name`. See documentation of `appsId`. (required)
+ versionsId: string, Part of `name`. See documentation of `appsId`. (required)
+ instancesId: string, Part of `name`. See documentation of `appsId`. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
+ "errors": 42, # Number of errors since this instance was started. @OutputOnly
+ "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. @OutputOnly
+ "startTimestamp": "A String", # Time that this instance was started. @OutputOnly
+ "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
+ "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
+ "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
+ "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
+ "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
+ "requests": 42, # Number of requests since this instance was started. @OutputOnly
+ "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "availability": "A String", # Availability of the instance. @OutputOnly
+ "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(appsId, modulesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists the instances of a version.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1`. (required)
+ modulesId: string, Part of `name`. See documentation of `appsId`. (required)
+ versionsId: string, Part of `name`. See documentation of `appsId`. (required)
+ pageSize: integer, Maximum results to return per page.
+ pageToken: string, Continuation token for fetching the next page of results.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Response message for `Instances.ListInstances`.
+ "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+ "instances": [ # The instances belonging to the requested version.
+ { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
+ "errors": 42, # Number of errors since this instance was started. @OutputOnly
+ "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. @OutputOnly
+ "startTimestamp": "A String", # Time that this instance was started. @OutputOnly
+ "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
+ "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
+ "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
+ "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
+ "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
+ "requests": 42, # Number of requests since this instance was started. @OutputOnly
+ "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "availability": "A String", # Availability of the instance. @OutputOnly
+ "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ },
+ ],
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/appengine_v1beta4.apps.operations.html b/docs/dyn/appengine_v1beta4.apps.operations.html
index 3767bf8..a4e0bb5 100644
--- a/docs/dyn/appengine_v1beta4.apps.operations.html
+++ b/docs/dyn/appengine_v1beta4.apps.operations.html
@@ -98,21 +98,21 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping above, the `name` should have the format of `operations/some/unique/name`.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
@@ -131,25 +131,25 @@
Returns:
An object of the form:
- { # The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
+ { # The response message for Operations.ListOperations.
"operations": [ # A list of operations that matches the specified filter in the request.
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping above, the `name` should have the format of `operations/some/unique/name`.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
],
diff --git a/docs/dyn/appengine_v1beta5.apps.html b/docs/dyn/appengine_v1beta5.apps.html
index 4445bfe..7b012ff 100644
--- a/docs/dyn/appengine_v1beta5.apps.html
+++ b/docs/dyn/appengine_v1beta5.apps.html
@@ -75,6 +75,11 @@
<h1><a href="appengine_v1beta5.html">Google App Engine Admin API</a> . <a href="appengine_v1beta5.apps.html">apps</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="appengine_v1beta5.apps.locations.html">locations()</a></code>
+</p>
+<p class="firstline">Returns the locations Resource.</p>
+
+<p class="toc_element">
<code><a href="appengine_v1beta5.apps.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
@@ -85,37 +90,149 @@
<p class="firstline">Returns the services Resource.</p>
<p class="toc_element">
+ <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the [Google Cloud Resource Manager create project topic](https://cloud.google.com/resource-manager/docs/creating-project).</p>
+<p class="toc_element">
<code><a href="#get">get(appsId, x__xgafv=None, ensureResourcesExist=None)</a></code></p>
<p class="firstline">Gets information about an application.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(appsId, body, mask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates application parameters.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="create">create(body, x__xgafv=None)</code>
+ <pre>Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the [Google Cloud Resource Manager create project topic](https://cloud.google.com/resource-manager/docs/creating-project).
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Application resource contains the top-level configuration of an App Engine application.
+ "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine. @OutputOnly
+ "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
+ "codeBucket": "A String", # A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
+ "defaultBucket": "A String", # A Google Cloud Storage bucket that can be used by the application to store content. @OutputOnly
+ "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. @OutputOnly
+ { # Rules to match an HTTP request and dispatch that request to a service.
+ "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+ "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
+ "service": "A String", # Resource id of a service in this application that should serve the matched request. The service must already exist. Example: `default`.
+ },
+ ],
+ "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
+ "location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
+ "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
+ "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(appsId, x__xgafv=None, ensureResourcesExist=None)</code>
<pre>Gets information about an application.
Args:
- appsId: string, Part of `name`. Name of the application to get. For example: "apps/myapp". (required)
+ appsId: string, Part of `name`. Name of the application to get. Example: `apps/myapp`. (required)
x__xgafv: string, V1 error format.
ensureResourcesExist: boolean, Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the `GET` operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API.
Returns:
An object of the form:
- { # An Application contains the top-level configuration of an App Engine application.
- "defaultHostname": "A String", # The hostname used to reach the application, as resolved by App Engine. @OutputOnly
- "name": "A String", # The full path to the application in the API. Example: "apps/myapp". @OutputOnly
- "codeBucket": "A String", # A Google Cloud Storage bucket which can be used for storing files associated with an application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
- "defaultBucket": "A String", # A Google Cloud Storage bucket which can be used by the application to store content. @OutputOnly
- "dispatchRules": [ # HTTP path dispatch rules for requests to the app that do not explicitly target a service or version. The rules are order-dependent. @OutputOnly
+ { # An Application resource contains the top-level configuration of an App Engine application.
+ "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine. @OutputOnly
+ "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
+ "codeBucket": "A String", # A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
+ "defaultBucket": "A String", # A Google Cloud Storage bucket that can be used by the application to store content. @OutputOnly
+ "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. @OutputOnly
+ { # Rules to match an HTTP request and dispatch that request to a service.
+ "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+ "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
+ "service": "A String", # Resource id of a service in this application that should serve the matched request. The service must already exist. Example: `default`.
+ },
+ ],
+ "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
+ "location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
+ "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
+ "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(appsId, body, mask=None, x__xgafv=None)</code>
+ <pre>Updates application parameters.
+
+Args:
+ appsId: string, Part of `name`. Name of the application to update. Example: `apps/myapp`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Application resource contains the top-level configuration of an App Engine application.
+ "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine. @OutputOnly
+ "name": "A String", # Full path to the Application resource in the API. Example: `apps/myapp`. @OutputOnly
+ "codeBucket": "A String", # A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
+ "defaultBucket": "A String", # A Google Cloud Storage bucket that can be used by the application to store content. @OutputOnly
+ "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. @OutputOnly
{ # Rules to match an HTTP request and dispatch that request to a service.
- "path": "A String", # The pathname within the host. This must start with a '/'. A single '*' (glob) can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
- "domain": "A String", # The domain name to match on. Supports '*' (glob) wildcarding on the left-hand side of a '.'. If empty, all domains will be matched (the same as '*').
- "service": "A String", # The resource id of a Service in this application that should service the matched request. The Service must already exist. Example: "default".
+ "path": "A String", # Pathname within the host. Must start with a "`/`". A single "`*`" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+ "domain": "A String", # Domain name to match against. The wildcard "`*`" is supported if specified before a period: "`*.`". Defaults to matching all domains: "`*`".
+ "service": "A String", # Resource id of a service in this application that should serve the matched request. The service must already exist. Example: `default`.
},
],
- "defaultCookieExpiration": "A String", # Determines the cookie expiration policy for the application. @OutputOnly
- "location": "A String", # The location from which the application will be run. Application instances will run out of data centers in the chosen location and all of the application's End User Content will be stored at rest. The default is "us-central". Choices are: "us-central" - Central US "europe-west" - Western Europe "us-east1" - Eastern US
- "authDomain": "A String", # If set, only users from the specified Google Apps authentication domain may access the application. If not set, any Google Account may access the application.
- "id": "A String", # The relative name/path of the application. Example: "myapp".
+ "defaultCookieExpiration": "A String", # Cookie expiration policy for this application. @OutputOnly
+ "location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored. Defaults to `us-central`. Options are: `us-central` - Central US `europe-west` - Western Europe `us-east1` - Eastern US
+ "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
+ "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: `myapp`.
+ }
+
+ mask: string, Standard field mask for the set of fields to be updated.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
diff --git a/docs/dyn/appengine_v1beta5.apps.locations.html b/docs/dyn/appengine_v1beta5.apps.locations.html
new file mode 100644
index 0000000..9f5bc47
--- /dev/null
+++ b/docs/dyn/appengine_v1beta5.apps.locations.html
@@ -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="appengine_v1beta5.html">Google App Engine Admin API</a> . <a href="appengine_v1beta5.apps.html">apps</a> . <a href="appengine_v1beta5.apps.locations.html">locations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(appsId, locationsId, x__xgafv=None)</a></code></p>
+<p class="firstline">Get information about a location.</p>
+<p class="toc_element">
+ <code><a href="#list">list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists information about the supported locations for this service.</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(appsId, locationsId, x__xgafv=None)</code>
+ <pre>Get information about a location.
+
+Args:
+ appsId: string, Part of `name`. Resource name for the location. (required)
+ locationsId: string, Part of `name`. See documentation of `appsId`. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A resource that represents Google Cloud Platform location.
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists information about the supported locations for this service.
+
+Args:
+ appsId: string, Part of `name`. The resource that owns the locations collection, if applicable. (required)
+ pageSize: integer, The standard list page size.
+ filter: string, The standard list filter.
+ pageToken: string, The standard list page token.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The response message for LocationService.ListLocations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "locations": [ # A list of locations that matches the specified filter in the request.
+ { # A resource that represents Google Cloud Platform location.
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/appengine_v1beta5.apps.operations.html b/docs/dyn/appengine_v1beta5.apps.operations.html
index 5dca89f..c16565f 100644
--- a/docs/dyn/appengine_v1beta5.apps.operations.html
+++ b/docs/dyn/appengine_v1beta5.apps.operations.html
@@ -98,21 +98,21 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
@@ -135,21 +135,21 @@
"operations": [ # A list of operations that matches the specified filter in the request.
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
],
diff --git a/docs/dyn/appengine_v1beta5.apps.services.html b/docs/dyn/appengine_v1beta5.apps.services.html
index 2aa5b2c..bfc93e0 100644
--- a/docs/dyn/appengine_v1beta5.apps.services.html
+++ b/docs/dyn/appengine_v1beta5.apps.services.html
@@ -81,10 +81,10 @@
<p class="toc_element">
<code><a href="#delete">delete(appsId, servicesId, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a service and all enclosed versions.</p>
+<p class="firstline">Deletes the specified service and all enclosed versions.</p>
<p class="toc_element">
<code><a href="#get">get(appsId, servicesId, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the current configuration of the service.</p>
+<p class="firstline">Gets the current configuration of the specified service.</p>
<p class="toc_element">
<code><a href="#list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the services in the application.</p>
@@ -97,10 +97,10 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(appsId, servicesId, x__xgafv=None)</code>
- <pre>Deletes a service and all enclosed versions.
+ <pre>Deletes the specified service and all enclosed versions.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default`. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
@@ -109,46 +109,46 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(appsId, servicesId, x__xgafv=None)</code>
- <pre>Gets the current configuration of the service.
+ <pre>Gets the current configuration of the specified service.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default`. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
- { # A service is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
- "split": { # Configuration for traffic splitting for versions within a single service. Traffic splitting allows traffic directed to the service to be assigned to one of several versions in a fractional way, enabling experiments and canarying new builds, for example. # A mapping that defines fractional HTTP traffic diversion to different versions within the service.
- "shardBy": "A String", # Which mechanism should be used as a selector when choosing a version to send a request to. The traffic selection algorithm will be stable for either type until allocations are changed.
- "allocations": { # Mapping from service version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated in this field may not be deleted until the service is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.
+ { # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
+ "split": { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
+ "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
+ "allocations": { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
"a_key": 3.14,
},
},
- "name": "A String", # The full path to the Service resource in the API. Example: "apps/myapp/services/default" @OutputOnly
- "id": "A String", # The relative name/path of the service within the application. Example: "default" @OutputOnly
+ "name": "A String", # Full path to the Service resource in the API. Example: `apps/myapp/services/default`. @OutputOnly
+ "id": "A String", # Relative name of the service within the application. Example: `default`. @OutputOnly
}</pre>
</div>
@@ -157,7 +157,7 @@
<pre>Lists all the services in the application.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp`. (required)
pageSize: integer, Maximum results to return per page.
pageToken: string, Continuation token for fetching the next page of results.
x__xgafv: string, V1 error format.
@@ -167,15 +167,15 @@
{ # Response message for `Services.ListServices`.
"services": [ # The services belonging to the requested application.
- { # A service is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
- "split": { # Configuration for traffic splitting for versions within a single service. Traffic splitting allows traffic directed to the service to be assigned to one of several versions in a fractional way, enabling experiments and canarying new builds, for example. # A mapping that defines fractional HTTP traffic diversion to different versions within the service.
- "shardBy": "A String", # Which mechanism should be used as a selector when choosing a version to send a request to. The traffic selection algorithm will be stable for either type until allocations are changed.
- "allocations": { # Mapping from service version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated in this field may not be deleted until the service is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.
+ { # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
+ "split": { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
+ "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
+ "allocations": { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
"a_key": 3.14,
},
},
- "name": "A String", # The full path to the Service resource in the API. Example: "apps/myapp/services/default" @OutputOnly
- "id": "A String", # The relative name/path of the service within the application. Example: "default" @OutputOnly
+ "name": "A String", # Full path to the Service resource in the API. Example: `apps/myapp/services/default`. @OutputOnly
+ "id": "A String", # Relative name of the service within the application. Example: `default`. @OutputOnly
},
],
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
@@ -201,23 +201,23 @@
<pre>Updates the configuration of the specified service.
Args:
- appsId: string, Part of `name`. Name of the resource to update. For example: "apps/myapp/services/default". (required)
+ appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/services/default`. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # A service is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
- "split": { # Configuration for traffic splitting for versions within a single service. Traffic splitting allows traffic directed to the service to be assigned to one of several versions in a fractional way, enabling experiments and canarying new builds, for example. # A mapping that defines fractional HTTP traffic diversion to different versions within the service.
- "shardBy": "A String", # Which mechanism should be used as a selector when choosing a version to send a request to. The traffic selection algorithm will be stable for either type until allocations are changed.
- "allocations": { # Mapping from service version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated in this field may not be deleted until the service is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.
+{ # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
+ "split": { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
+ "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
+ "allocations": { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
"a_key": 3.14,
},
},
- "name": "A String", # The full path to the Service resource in the API. Example: "apps/myapp/services/default" @OutputOnly
- "id": "A String", # The relative name/path of the service within the application. Example: "default" @OutputOnly
+ "name": "A String", # Full path to the Service resource in the API. Example: `apps/myapp/services/default`. @OutputOnly
+ "id": "A String", # Relative name of the service within the application. Example: `default`. @OutputOnly
}
- migrateTraffic: boolean, Whether to use Traffic Migration to shift traffic gradually. Traffic can only be migrated from a single version to another single version.
+ migrateTraffic: boolean, Set to `true` to gradually shift traffic from one version to another single version. By default, traffic is shifted immediately. For gradual traffic migration, the target version must be located within instances that are configured for both [warmup requests](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#inboundservicetype) and [automatic scaling](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the [`shardBy`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see [Migrating and Splitting Traffic](https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
mask: string, Standard field mask for the set of fields to be updated.
x__xgafv: string, V1 error format.
@@ -226,21 +226,21 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
diff --git a/docs/dyn/appengine_v1beta5.apps.services.versions.html b/docs/dyn/appengine_v1beta5.apps.services.versions.html
index 5011f62..043b3eb 100644
--- a/docs/dyn/appengine_v1beta5.apps.services.versions.html
+++ b/docs/dyn/appengine_v1beta5.apps.services.versions.html
@@ -81,13 +81,13 @@
<p class="toc_element">
<code><a href="#create">create(appsId, servicesId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Deploys new code and resource files to a version.</p>
+<p class="firstline">Deploys new code and resource files to a new version.</p>
<p class="toc_element">
<code><a href="#delete">delete(appsId, servicesId, versionsId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing version.</p>
<p class="toc_element">
<code><a href="#get">get(appsId, servicesId, versionsId, x__xgafv=None, view=None)</a></code></p>
-<p class="firstline">Gets application deployment information.</p>
+<p class="firstline">Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.</p>
<p class="toc_element">
<code><a href="#list">list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None)</a></code></p>
<p class="firstline">Lists the versions of a service.</p>
@@ -96,11 +96,11 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(appsId, servicesId, versionsId, body, mask=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates an existing version. Note: UNIMPLEMENTED.</p>
+<p class="firstline">Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(appsId, servicesId, body, x__xgafv=None)</code>
- <pre>Deploys new code and resource files to a version.
+ <pre>Deploys new code and resource files to a new version.
Args:
appsId: string, Part of `name`. Name of the resource to update. For example: "apps/myapp/services/default". (required)
@@ -108,151 +108,151 @@
body: object, The request body. (required)
The object takes the form of:
-{ # A Version is a specific set of source code and configuration files deployed to a service.
+{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
"basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
- "idleTimeout": "A String", # The instance will be shut down this amount of time after receiving its last request.
- "maxInstances": 42, # The maximum number of instances for App Engine to create for this version.
+ "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
+ "maxInstances": 42, # Maximum number of instances to create for this version.
},
- "betaSettings": { # Beta settings supplied to the application via metadata.
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
"a_key": "A String",
},
- "vm": True or False, # Whether to deploy this app in a VM container.
- "instanceClass": "A String", # The instance class to use to run this app. Valid values for AutomaticScaling are `[F1, F2, F4, F4_1G]`. Valid values for ManualScaling and BasicScaling are `[B1, B2, B4, B8, B4_1G]`. Default: "F1" for AutomaticScaling, "B1" for ManualScaling and BasicScaling
- "errorHandlers": [ # Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A custom static error page to be served when an error occurs.
- "errorCode": "A String", # The error condition this handler applies to.
- "mimeType": "A String", # MIME type of file. If unspecified, "text/html" is assumed.
+ "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
+ "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
+ "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
+ { # Custom static error page to be served when an error occurs.
+ "errorCode": "A String", # Error condition this handler applies to.
+ "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
"staticFile": "A String", # Static file content to be served for this error.
},
],
- "id": "A String", # The relative name/path of the Version within the service. Example: "v1". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used.
- "apiConfig": { # API Serving configuration for Cloud Endpoints. # Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
+ "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
"url": "A String", # URL to serve the endpoint at.
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "login": "A String", # What level of login is required to access this resource. Default is "optional".
- "script": "A String", # Specifies the path to the script from the application root directory.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
+ "script": "A String", # Path to the script from the application root directory.
},
- "threadsafe": True or False, # If true, multiple requests can be dispatched to the app at once.
- "healthCheck": { # Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances. # Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "restartThreshold": 42, # The number of consecutive failed health checks before an instance is restarted.
- "checkInterval": "A String", # The interval between health checks.
- "unhealthyThreshold": 42, # The number of consecutive failed health checks before removing traffic.
- "healthyThreshold": 42, # The number of consecutive successful health checks before receiving traffic.
- "host": "A String", # The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)
- "timeout": "A String", # The amount of time before the health check is considered failed.
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
+ "checkInterval": "A String", # Interval between health checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
+ "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
+ "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
- "defaultExpiration": "A String", # The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "libraries": [ # Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A Python runtime third-party library required by the application.
- "version": "A String", # The version of the library to select, or "latest".
- "name": "A String", # The name of the library, e.g. "PIL" or "django".
+ "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
+ "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
+ { # Third-party Python runtime library that is required by the application.
+ "version": "A String", # Version of the library to select, or "latest".
+ "name": "A String", # Name of the library. Example: "django".
},
],
- "deployer": "A String", # The email address of the user who created this version. @OutputOnly
- "env": "A String", # The App Engine execution environment to use for this version. Default: "1"
+ "deployer": "A String", # Email address of the user who created this version. @OutputOnly
+ "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
"diskUsageBytes": "A String", # Total size of version files hosted on App Engine disk in bytes. @OutputOnly
- "automaticScaling": { # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics. # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
- "minPendingLatency": "A String", # The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "networkUtilization": { # Target scaling by network usage (for VM runtimes only). # Target scaling by network usage.
- "targetReceivedBytesPerSec": 42, # Target bytes per second received.
- "targetSentBytesPerSec": 42, # Target bytes per second sent.
- "targetReceivedPacketsPerSec": 42, # Target packets per second received.
- "targetSentPacketsPerSec": 42, # Target packets per second sent.
+ "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
+ "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
+ "targetReceivedBytesPerSec": 42, # Target bytes received per second.
+ "targetSentBytesPerSec": 42, # Target bytes sent per second.
+ "targetReceivedPacketsPerSec": 42, # Target packets received per second.
+ "targetSentPacketsPerSec": 42, # Target packets sent per second.
},
- "diskUtilization": { # Target scaling by disk usage (for VM runtimes only). # Target scaling by disk usage.
- "targetWriteOpsPerSec": 42, # Target ops per second written.
- "targetReadBytesPerSec": 42, # Target bytes per second read.
- "targetReadOpsPerSec": 42, # Target ops per second read.
- "targetWriteBytesPerSec": 42, # Target bytes per second written.
+ "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
+ "targetWriteOpsPerSec": 42, # Target ops written per second.
+ "targetReadBytesPerSec": 42, # Target bytes read per second.
+ "targetReadOpsPerSec": 42, # Target ops read per second.
+ "targetWriteBytesPerSec": 42, # Target bytes written per second.
},
- "maxPendingLatency": "A String", # The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "maxIdleInstances": 42, # The maximum number of idle instances that App Engine should maintain for this version.
- "minIdleInstances": 42, # The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a service, since other versions are not expected to receive significant traffic.
- "requestUtilization": { # Target scaling by request utilization (for VM runtimes only). # Target scaling by request utilization.
+ "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
+ "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
+ "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
"targetConcurrentRequests": 42, # Target number of concurrent requests.
"targetRequestCountPerSec": 42, # Target requests per second.
},
- "coolDownPeriod": "A String", # The amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Applies only to the VM runtime.
- "maxTotalInstances": 42, # Max number of instances that App Engine should start to handle requests.
- "maxConcurrentRequests": 42, # The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.
- "minTotalInstances": 42, # Minimum number of instances that App Engine should maintain.
+ "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
+ "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
+ "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
+ "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
"cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target (0-1) CPU utilization ratio to maintain when scaling.
- "aggregationWindowLength": "A String", # The period of time over which CPU utilization is calculated.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
},
},
- "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
"a_key": "A String",
},
- "resources": { # Used to specify how many machine resources an app version needs. # Used to specify how many machine resources an app version needs (for VM runtimes only).
- "diskGb": 3.14, # How much disk size, in GB, an app version needs.
- "cpu": 3.14, # How many CPU cores an app version needs.
- "memoryGb": 3.14, # How much memory, in GB, an app version needs.
+ "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
+ "diskGb": 3.14, # Disk size (GB) needed.
+ "cpu": 3.14, # Number of CPU cores needed.
+ "memoryGb": 3.14, # Memory (GB) needed.
},
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
- "instances": 42, # The number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
+ "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
},
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "files": { # A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
- "a_key": { # A single source file which is part of the application to be deployed.
- "mimeType": "A String", # The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used.
- "sourceUrl": "A String", # The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
- "sha1Sum": "A String", # The SHA1 (160 bits) hash of the file in hex.
+ "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
+ "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
+ "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
+ "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
+ "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
- "sourceReferences": [ # The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.
- { # A reference to a particular snapshot of the source tree used to build and deploy the application.
- "revisionId": "A String", # The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
- "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
+ "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
+ { # Reference to a particular snapshot of the source tree used to build and deploy the application.
+ "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
+ "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # A Docker (container) image which should be used to start the application. # If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime.
- "image": "A String", # Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@digest
+ "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
- "network": { # Used to specify extra network settings (for VM runtimes only). # Used to specify extra network settings (for VM runtimes only).
- "instanceTag": "A String", # A tag to apply to the VM instance during creation.
- "forwardedPorts": [ # A list of ports (or port pairs) to forward from the VM into the app container.
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
"A String",
],
- "name": "A String", # The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named "default" will be used. (The short name should be specified, not the resource path.)
+ "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
},
- "nobuildFilesRegex": "A String", # Go only. Files that match this pattern will not be built into the app. May only be set on create requests.
- "name": "A String", # The full path to the Version resource in the API. Example: "apps/myapp/services/default/versions/v1". @OutputOnly
- "handlers": [ # An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "urlRegex": "A String", # A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required.
- "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches the URL pattern.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
+ "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
+ { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
+ "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
- "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
- "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
- "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
- "requireMatchingFile": True or False, # If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL.
- "uploadPathRegex": "A String", # A regular expression that matches the file paths for all files that will be referenced by this handler.
- "path": "A String", # The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
+ "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
+ "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
},
- "apiEndpoint": { # Use Google Cloud Endpoints to handle requests. # Use API Endpoints to handle requests.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
- "login": "A String", # What level of login is required to access this resource.
- "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. A `302` is used by default.
+ "login": "A String", # Level of login required to access this resource.
+ "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
},
],
- "creationTime": "A String", # Creation time of this version. This will be between the start and end times of the operation that creates this version. @OutputOnly
- "servingStatus": "A String", # The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.
- "runtime": "A String", # The desired runtime. Values can include python27, java7, go, etc.
+ "creationTime": "A String", # Time that this version was created. @OutputOnly
+ "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
+ "runtime": "A String", # Desired runtime. Example: `python27`.
}
x__xgafv: string, V1 error format.
@@ -262,21 +262,21 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
@@ -286,7 +286,7 @@
<pre>Deletes an existing version.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default/versions/v1". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1`. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
@@ -296,31 +296,31 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(appsId, servicesId, versionsId, x__xgafv=None, view=None)</code>
- <pre>Gets application deployment information.
+ <pre>Gets the specified Version resource. By default, only a `BASIC_VIEW` will be returned. Specify the `FULL_VIEW` parameter to get the full resource.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default/versions/v1". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1`. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
@@ -329,151 +329,151 @@
Returns:
An object of the form:
- { # A Version is a specific set of source code and configuration files deployed to a service.
+ { # A Version resource is a specific set of source code and configuration files that are deployed into a service.
"basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
- "idleTimeout": "A String", # The instance will be shut down this amount of time after receiving its last request.
- "maxInstances": 42, # The maximum number of instances for App Engine to create for this version.
+ "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
+ "maxInstances": 42, # Maximum number of instances to create for this version.
},
- "betaSettings": { # Beta settings supplied to the application via metadata.
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
"a_key": "A String",
},
- "vm": True or False, # Whether to deploy this app in a VM container.
- "instanceClass": "A String", # The instance class to use to run this app. Valid values for AutomaticScaling are `[F1, F2, F4, F4_1G]`. Valid values for ManualScaling and BasicScaling are `[B1, B2, B4, B8, B4_1G]`. Default: "F1" for AutomaticScaling, "B1" for ManualScaling and BasicScaling
- "errorHandlers": [ # Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A custom static error page to be served when an error occurs.
- "errorCode": "A String", # The error condition this handler applies to.
- "mimeType": "A String", # MIME type of file. If unspecified, "text/html" is assumed.
+ "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
+ "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
+ "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
+ { # Custom static error page to be served when an error occurs.
+ "errorCode": "A String", # Error condition this handler applies to.
+ "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
"staticFile": "A String", # Static file content to be served for this error.
},
],
- "id": "A String", # The relative name/path of the Version within the service. Example: "v1". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used.
- "apiConfig": { # API Serving configuration for Cloud Endpoints. # Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
+ "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
"url": "A String", # URL to serve the endpoint at.
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "login": "A String", # What level of login is required to access this resource. Default is "optional".
- "script": "A String", # Specifies the path to the script from the application root directory.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
+ "script": "A String", # Path to the script from the application root directory.
},
- "threadsafe": True or False, # If true, multiple requests can be dispatched to the app at once.
- "healthCheck": { # Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances. # Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "restartThreshold": 42, # The number of consecutive failed health checks before an instance is restarted.
- "checkInterval": "A String", # The interval between health checks.
- "unhealthyThreshold": 42, # The number of consecutive failed health checks before removing traffic.
- "healthyThreshold": 42, # The number of consecutive successful health checks before receiving traffic.
- "host": "A String", # The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)
- "timeout": "A String", # The amount of time before the health check is considered failed.
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
+ "checkInterval": "A String", # Interval between health checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
+ "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
+ "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
- "defaultExpiration": "A String", # The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "libraries": [ # Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A Python runtime third-party library required by the application.
- "version": "A String", # The version of the library to select, or "latest".
- "name": "A String", # The name of the library, e.g. "PIL" or "django".
+ "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
+ "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
+ { # Third-party Python runtime library that is required by the application.
+ "version": "A String", # Version of the library to select, or "latest".
+ "name": "A String", # Name of the library. Example: "django".
},
],
- "deployer": "A String", # The email address of the user who created this version. @OutputOnly
- "env": "A String", # The App Engine execution environment to use for this version. Default: "1"
+ "deployer": "A String", # Email address of the user who created this version. @OutputOnly
+ "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
"diskUsageBytes": "A String", # Total size of version files hosted on App Engine disk in bytes. @OutputOnly
- "automaticScaling": { # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics. # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
- "minPendingLatency": "A String", # The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "networkUtilization": { # Target scaling by network usage (for VM runtimes only). # Target scaling by network usage.
- "targetReceivedBytesPerSec": 42, # Target bytes per second received.
- "targetSentBytesPerSec": 42, # Target bytes per second sent.
- "targetReceivedPacketsPerSec": 42, # Target packets per second received.
- "targetSentPacketsPerSec": 42, # Target packets per second sent.
+ "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
+ "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
+ "targetReceivedBytesPerSec": 42, # Target bytes received per second.
+ "targetSentBytesPerSec": 42, # Target bytes sent per second.
+ "targetReceivedPacketsPerSec": 42, # Target packets received per second.
+ "targetSentPacketsPerSec": 42, # Target packets sent per second.
},
- "diskUtilization": { # Target scaling by disk usage (for VM runtimes only). # Target scaling by disk usage.
- "targetWriteOpsPerSec": 42, # Target ops per second written.
- "targetReadBytesPerSec": 42, # Target bytes per second read.
- "targetReadOpsPerSec": 42, # Target ops per second read.
- "targetWriteBytesPerSec": 42, # Target bytes per second written.
+ "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
+ "targetWriteOpsPerSec": 42, # Target ops written per second.
+ "targetReadBytesPerSec": 42, # Target bytes read per second.
+ "targetReadOpsPerSec": 42, # Target ops read per second.
+ "targetWriteBytesPerSec": 42, # Target bytes written per second.
},
- "maxPendingLatency": "A String", # The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "maxIdleInstances": 42, # The maximum number of idle instances that App Engine should maintain for this version.
- "minIdleInstances": 42, # The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a service, since other versions are not expected to receive significant traffic.
- "requestUtilization": { # Target scaling by request utilization (for VM runtimes only). # Target scaling by request utilization.
+ "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
+ "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
+ "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
"targetConcurrentRequests": 42, # Target number of concurrent requests.
"targetRequestCountPerSec": 42, # Target requests per second.
},
- "coolDownPeriod": "A String", # The amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Applies only to the VM runtime.
- "maxTotalInstances": 42, # Max number of instances that App Engine should start to handle requests.
- "maxConcurrentRequests": 42, # The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.
- "minTotalInstances": 42, # Minimum number of instances that App Engine should maintain.
+ "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
+ "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
+ "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
+ "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
"cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target (0-1) CPU utilization ratio to maintain when scaling.
- "aggregationWindowLength": "A String", # The period of time over which CPU utilization is calculated.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
},
},
- "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
"a_key": "A String",
},
- "resources": { # Used to specify how many machine resources an app version needs. # Used to specify how many machine resources an app version needs (for VM runtimes only).
- "diskGb": 3.14, # How much disk size, in GB, an app version needs.
- "cpu": 3.14, # How many CPU cores an app version needs.
- "memoryGb": 3.14, # How much memory, in GB, an app version needs.
+ "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
+ "diskGb": 3.14, # Disk size (GB) needed.
+ "cpu": 3.14, # Number of CPU cores needed.
+ "memoryGb": 3.14, # Memory (GB) needed.
},
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
- "instances": 42, # The number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
+ "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
},
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "files": { # A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
- "a_key": { # A single source file which is part of the application to be deployed.
- "mimeType": "A String", # The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used.
- "sourceUrl": "A String", # The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
- "sha1Sum": "A String", # The SHA1 (160 bits) hash of the file in hex.
+ "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
+ "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
+ "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
+ "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
+ "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
- "sourceReferences": [ # The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.
- { # A reference to a particular snapshot of the source tree used to build and deploy the application.
- "revisionId": "A String", # The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
- "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
+ "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
+ { # Reference to a particular snapshot of the source tree used to build and deploy the application.
+ "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
+ "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # A Docker (container) image which should be used to start the application. # If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime.
- "image": "A String", # Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@digest
+ "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
- "network": { # Used to specify extra network settings (for VM runtimes only). # Used to specify extra network settings (for VM runtimes only).
- "instanceTag": "A String", # A tag to apply to the VM instance during creation.
- "forwardedPorts": [ # A list of ports (or port pairs) to forward from the VM into the app container.
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
"A String",
],
- "name": "A String", # The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named "default" will be used. (The short name should be specified, not the resource path.)
+ "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
},
- "nobuildFilesRegex": "A String", # Go only. Files that match this pattern will not be built into the app. May only be set on create requests.
- "name": "A String", # The full path to the Version resource in the API. Example: "apps/myapp/services/default/versions/v1". @OutputOnly
- "handlers": [ # An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "urlRegex": "A String", # A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required.
- "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches the URL pattern.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
+ "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
+ { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
+ "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
- "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
- "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
- "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
- "requireMatchingFile": True or False, # If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL.
- "uploadPathRegex": "A String", # A regular expression that matches the file paths for all files that will be referenced by this handler.
- "path": "A String", # The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
+ "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
+ "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
},
- "apiEndpoint": { # Use Google Cloud Endpoints to handle requests. # Use API Endpoints to handle requests.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
- "login": "A String", # What level of login is required to access this resource.
- "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. A `302` is used by default.
+ "login": "A String", # Level of login required to access this resource.
+ "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
},
],
- "creationTime": "A String", # Creation time of this version. This will be between the start and end times of the operation that creates this version. @OutputOnly
- "servingStatus": "A String", # The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.
- "runtime": "A String", # The desired runtime. Values can include python27, java7, go, etc.
+ "creationTime": "A String", # Time that this version was created. @OutputOnly
+ "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
+ "runtime": "A String", # Desired runtime. Example: `python27`.
}</pre>
</div>
@@ -482,7 +482,7 @@
<pre>Lists the versions of a service.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default`. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
pageSize: integer, Maximum results to return per page.
x__xgafv: string, V1 error format.
@@ -494,152 +494,152 @@
{ # Response message for `Versions.ListVersions`.
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
- "versions": [ # The versions belonging to the requested application service.
- { # A Version is a specific set of source code and configuration files deployed to a service.
+ "versions": [ # The versions belonging to the requested service.
+ { # A Version resource is a specific set of source code and configuration files that are deployed into a service.
"basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
- "idleTimeout": "A String", # The instance will be shut down this amount of time after receiving its last request.
- "maxInstances": 42, # The maximum number of instances for App Engine to create for this version.
+ "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
+ "maxInstances": 42, # Maximum number of instances to create for this version.
},
- "betaSettings": { # Beta settings supplied to the application via metadata.
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
"a_key": "A String",
},
- "vm": True or False, # Whether to deploy this app in a VM container.
- "instanceClass": "A String", # The instance class to use to run this app. Valid values for AutomaticScaling are `[F1, F2, F4, F4_1G]`. Valid values for ManualScaling and BasicScaling are `[B1, B2, B4, B8, B4_1G]`. Default: "F1" for AutomaticScaling, "B1" for ManualScaling and BasicScaling
- "errorHandlers": [ # Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A custom static error page to be served when an error occurs.
- "errorCode": "A String", # The error condition this handler applies to.
- "mimeType": "A String", # MIME type of file. If unspecified, "text/html" is assumed.
+ "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
+ "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
+ "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
+ { # Custom static error page to be served when an error occurs.
+ "errorCode": "A String", # Error condition this handler applies to.
+ "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
"staticFile": "A String", # Static file content to be served for this error.
},
],
- "id": "A String", # The relative name/path of the Version within the service. Example: "v1". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used.
- "apiConfig": { # API Serving configuration for Cloud Endpoints. # Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
+ "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
"url": "A String", # URL to serve the endpoint at.
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "login": "A String", # What level of login is required to access this resource. Default is "optional".
- "script": "A String", # Specifies the path to the script from the application root directory.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
+ "script": "A String", # Path to the script from the application root directory.
},
- "threadsafe": True or False, # If true, multiple requests can be dispatched to the app at once.
- "healthCheck": { # Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances. # Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "restartThreshold": 42, # The number of consecutive failed health checks before an instance is restarted.
- "checkInterval": "A String", # The interval between health checks.
- "unhealthyThreshold": 42, # The number of consecutive failed health checks before removing traffic.
- "healthyThreshold": 42, # The number of consecutive successful health checks before receiving traffic.
- "host": "A String", # The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)
- "timeout": "A String", # The amount of time before the health check is considered failed.
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
+ "checkInterval": "A String", # Interval between health checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
+ "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
+ "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
- "defaultExpiration": "A String", # The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "libraries": [ # Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A Python runtime third-party library required by the application.
- "version": "A String", # The version of the library to select, or "latest".
- "name": "A String", # The name of the library, e.g. "PIL" or "django".
+ "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
+ "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
+ { # Third-party Python runtime library that is required by the application.
+ "version": "A String", # Version of the library to select, or "latest".
+ "name": "A String", # Name of the library. Example: "django".
},
],
- "deployer": "A String", # The email address of the user who created this version. @OutputOnly
- "env": "A String", # The App Engine execution environment to use for this version. Default: "1"
+ "deployer": "A String", # Email address of the user who created this version. @OutputOnly
+ "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
"diskUsageBytes": "A String", # Total size of version files hosted on App Engine disk in bytes. @OutputOnly
- "automaticScaling": { # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics. # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
- "minPendingLatency": "A String", # The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "networkUtilization": { # Target scaling by network usage (for VM runtimes only). # Target scaling by network usage.
- "targetReceivedBytesPerSec": 42, # Target bytes per second received.
- "targetSentBytesPerSec": 42, # Target bytes per second sent.
- "targetReceivedPacketsPerSec": 42, # Target packets per second received.
- "targetSentPacketsPerSec": 42, # Target packets per second sent.
+ "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
+ "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
+ "targetReceivedBytesPerSec": 42, # Target bytes received per second.
+ "targetSentBytesPerSec": 42, # Target bytes sent per second.
+ "targetReceivedPacketsPerSec": 42, # Target packets received per second.
+ "targetSentPacketsPerSec": 42, # Target packets sent per second.
},
- "diskUtilization": { # Target scaling by disk usage (for VM runtimes only). # Target scaling by disk usage.
- "targetWriteOpsPerSec": 42, # Target ops per second written.
- "targetReadBytesPerSec": 42, # Target bytes per second read.
- "targetReadOpsPerSec": 42, # Target ops per second read.
- "targetWriteBytesPerSec": 42, # Target bytes per second written.
+ "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
+ "targetWriteOpsPerSec": 42, # Target ops written per second.
+ "targetReadBytesPerSec": 42, # Target bytes read per second.
+ "targetReadOpsPerSec": 42, # Target ops read per second.
+ "targetWriteBytesPerSec": 42, # Target bytes written per second.
},
- "maxPendingLatency": "A String", # The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "maxIdleInstances": 42, # The maximum number of idle instances that App Engine should maintain for this version.
- "minIdleInstances": 42, # The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a service, since other versions are not expected to receive significant traffic.
- "requestUtilization": { # Target scaling by request utilization (for VM runtimes only). # Target scaling by request utilization.
+ "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
+ "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
+ "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
"targetConcurrentRequests": 42, # Target number of concurrent requests.
"targetRequestCountPerSec": 42, # Target requests per second.
},
- "coolDownPeriod": "A String", # The amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Applies only to the VM runtime.
- "maxTotalInstances": 42, # Max number of instances that App Engine should start to handle requests.
- "maxConcurrentRequests": 42, # The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.
- "minTotalInstances": 42, # Minimum number of instances that App Engine should maintain.
+ "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
+ "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
+ "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
+ "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
"cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target (0-1) CPU utilization ratio to maintain when scaling.
- "aggregationWindowLength": "A String", # The period of time over which CPU utilization is calculated.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
},
},
- "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
"a_key": "A String",
},
- "resources": { # Used to specify how many machine resources an app version needs. # Used to specify how many machine resources an app version needs (for VM runtimes only).
- "diskGb": 3.14, # How much disk size, in GB, an app version needs.
- "cpu": 3.14, # How many CPU cores an app version needs.
- "memoryGb": 3.14, # How much memory, in GB, an app version needs.
+ "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
+ "diskGb": 3.14, # Disk size (GB) needed.
+ "cpu": 3.14, # Number of CPU cores needed.
+ "memoryGb": 3.14, # Memory (GB) needed.
},
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
- "instances": 42, # The number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
+ "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
},
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "files": { # A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
- "a_key": { # A single source file which is part of the application to be deployed.
- "mimeType": "A String", # The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used.
- "sourceUrl": "A String", # The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
- "sha1Sum": "A String", # The SHA1 (160 bits) hash of the file in hex.
+ "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
+ "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
+ "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
+ "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
+ "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
- "sourceReferences": [ # The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.
- { # A reference to a particular snapshot of the source tree used to build and deploy the application.
- "revisionId": "A String", # The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
- "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
+ "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
+ { # Reference to a particular snapshot of the source tree used to build and deploy the application.
+ "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
+ "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # A Docker (container) image which should be used to start the application. # If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime.
- "image": "A String", # Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@digest
+ "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
- "network": { # Used to specify extra network settings (for VM runtimes only). # Used to specify extra network settings (for VM runtimes only).
- "instanceTag": "A String", # A tag to apply to the VM instance during creation.
- "forwardedPorts": [ # A list of ports (or port pairs) to forward from the VM into the app container.
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
"A String",
],
- "name": "A String", # The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named "default" will be used. (The short name should be specified, not the resource path.)
+ "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
},
- "nobuildFilesRegex": "A String", # Go only. Files that match this pattern will not be built into the app. May only be set on create requests.
- "name": "A String", # The full path to the Version resource in the API. Example: "apps/myapp/services/default/versions/v1". @OutputOnly
- "handlers": [ # An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "urlRegex": "A String", # A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required.
- "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches the URL pattern.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
+ "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
+ { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
+ "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
- "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
- "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
- "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
- "requireMatchingFile": True or False, # If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL.
- "uploadPathRegex": "A String", # A regular expression that matches the file paths for all files that will be referenced by this handler.
- "path": "A String", # The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
+ "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
+ "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
},
- "apiEndpoint": { # Use Google Cloud Endpoints to handle requests. # Use API Endpoints to handle requests.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
- "login": "A String", # What level of login is required to access this resource.
- "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. A `302` is used by default.
+ "login": "A String", # Level of login required to access this resource.
+ "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
},
],
- "creationTime": "A String", # Creation time of this version. This will be between the start and end times of the operation that creates this version. @OutputOnly
- "servingStatus": "A String", # The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.
- "runtime": "A String", # The desired runtime. Values can include python27, java7, go, etc.
+ "creationTime": "A String", # Time that this version was created. @OutputOnly
+ "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
+ "runtime": "A String", # Desired runtime. Example: `python27`.
},
],
}</pre>
@@ -661,160 +661,160 @@
<div class="method">
<code class="details" id="patch">patch(appsId, servicesId, versionsId, body, mask=None, x__xgafv=None)</code>
- <pre>Updates an existing version. Note: UNIMPLEMENTED.
+ <pre>Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * [`serving_status`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. * [`instance_class`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. * [`automatic_scaling.min_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. * [`automatic_scaling.max_idle_instances`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.
Args:
- appsId: string, Part of `name`. Name of the resource to update. For example: "apps/myapp/services/default/versions/1". (required)
+ appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/services/default/versions/1`. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # A Version is a specific set of source code and configuration files deployed to a service.
+{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
"basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
- "idleTimeout": "A String", # The instance will be shut down this amount of time after receiving its last request.
- "maxInstances": 42, # The maximum number of instances for App Engine to create for this version.
+ "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
+ "maxInstances": 42, # Maximum number of instances to create for this version.
},
- "betaSettings": { # Beta settings supplied to the application via metadata.
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
"a_key": "A String",
},
- "vm": True or False, # Whether to deploy this app in a VM container.
- "instanceClass": "A String", # The instance class to use to run this app. Valid values for AutomaticScaling are `[F1, F2, F4, F4_1G]`. Valid values for ManualScaling and BasicScaling are `[B1, B2, B4, B8, B4_1G]`. Default: "F1" for AutomaticScaling, "B1" for ManualScaling and BasicScaling
- "errorHandlers": [ # Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A custom static error page to be served when an error occurs.
- "errorCode": "A String", # The error condition this handler applies to.
- "mimeType": "A String", # MIME type of file. If unspecified, "text/html" is assumed.
+ "vm": True or False, # Whether to deploy this version in a container on a virtual machine.
+ "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: * AutomaticScaling: `F1`, `F2`, `F4`, `F4_1G` * ManualScaling or BasicScaling: `B1`, `B2`, `B4`, `B8`, `B4_1G` Defaults to `F1` for AutomaticScaling and `B1` for ManualScaling or BasicScaling.
+ "errorHandlers": [ # Custom static error pages. Limited to 10KB per page. Only returned in `GET` requests if `view=FULL` is set.
+ { # Custom static error page to be served when an error occurs.
+ "errorCode": "A String", # Error condition this handler applies to.
+ "mimeType": "A String", # MIME type of file. Defaults to `text/html`.
"staticFile": "A String", # Static file content to be served for this error.
},
],
- "id": "A String", # The relative name/path of the Version within the service. Example: "v1". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used.
- "apiConfig": { # API Serving configuration for Cloud Endpoints. # Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "id": "A String", # Relative name of the version within the module. Example: `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
+ "apiConfig": { # [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/). Only returned in `GET` requests if `view=FULL` is set.
"url": "A String", # URL to serve the endpoint at.
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "login": "A String", # What level of login is required to access this resource. Default is "optional".
- "script": "A String", # Specifies the path to the script from the application root directory.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "login": "A String", # Level of login required to access this resource. Defaults to `optional`.
+ "script": "A String", # Path to the script from the application root directory.
},
- "threadsafe": True or False, # If true, multiple requests can be dispatched to the app at once.
- "healthCheck": { # Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances. # Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "restartThreshold": 42, # The number of consecutive failed health checks before an instance is restarted.
- "checkInterval": "A String", # The interval between health checks.
- "unhealthyThreshold": 42, # The number of consecutive failed health checks before removing traffic.
- "healthyThreshold": 42, # The number of consecutive successful health checks before receiving traffic.
- "host": "A String", # The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)
- "timeout": "A String", # The amount of time before the health check is considered failed.
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
+ "checkInterval": "A String", # Interval between health checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
+ "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
+ "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
- "defaultExpiration": "A String", # The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "libraries": [ # Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A Python runtime third-party library required by the application.
- "version": "A String", # The version of the library to select, or "latest".
- "name": "A String", # The name of the library, e.g. "PIL" or "django".
+ "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding [StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time. Only returned in `GET` requests if `view=FULL` is set.
+ "libraries": [ # Configuration for third-party Python runtime libraries required by the application. Only returned in `GET` requests if `view=FULL` is set.
+ { # Third-party Python runtime library that is required by the application.
+ "version": "A String", # Version of the library to select, or "latest".
+ "name": "A String", # Name of the library. Example: "django".
},
],
- "deployer": "A String", # The email address of the user who created this version. @OutputOnly
- "env": "A String", # The App Engine execution environment to use for this version. Default: "1"
+ "deployer": "A String", # Email address of the user who created this version. @OutputOnly
+ "env": "A String", # App Engine execution environment to use for this version. Defaults to `1`.
"diskUsageBytes": "A String", # Total size of version files hosted on App Engine disk in bytes. @OutputOnly
- "automaticScaling": { # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics. # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
- "minPendingLatency": "A String", # The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "networkUtilization": { # Target scaling by network usage (for VM runtimes only). # Target scaling by network usage.
- "targetReceivedBytesPerSec": 42, # Target bytes per second received.
- "targetSentBytesPerSec": 42, # Target bytes per second sent.
- "targetReceivedPacketsPerSec": 42, # Target packets per second received.
- "targetSentPacketsPerSec": 42, # Target packets per second sent.
+ "automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
+ "networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
+ "targetReceivedBytesPerSec": 42, # Target bytes received per second.
+ "targetSentBytesPerSec": 42, # Target bytes sent per second.
+ "targetReceivedPacketsPerSec": 42, # Target packets received per second.
+ "targetSentPacketsPerSec": 42, # Target packets sent per second.
},
- "diskUtilization": { # Target scaling by disk usage (for VM runtimes only). # Target scaling by disk usage.
- "targetWriteOpsPerSec": 42, # Target ops per second written.
- "targetReadBytesPerSec": 42, # Target bytes per second read.
- "targetReadOpsPerSec": 42, # Target ops per second read.
- "targetWriteBytesPerSec": 42, # Target bytes per second written.
+ "diskUtilization": { # Target scaling by disk usage. Only applicable for VM runtimes. # Target scaling by disk usage.
+ "targetWriteOpsPerSec": 42, # Target ops written per second.
+ "targetReadBytesPerSec": 42, # Target bytes read per second.
+ "targetReadOpsPerSec": 42, # Target ops read per second.
+ "targetWriteBytesPerSec": 42, # Target bytes written per second.
},
- "maxPendingLatency": "A String", # The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
- "maxIdleInstances": 42, # The maximum number of idle instances that App Engine should maintain for this version.
- "minIdleInstances": 42, # The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a service, since other versions are not expected to receive significant traffic.
- "requestUtilization": { # Target scaling by request utilization (for VM runtimes only). # Target scaling by request utilization.
+ "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
+ "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.
+ "requestUtilization": { # Target scaling by request utilization. Only applicable for VM runtimes. # Target scaling by request utilization.
"targetConcurrentRequests": 42, # Target number of concurrent requests.
"targetRequestCountPerSec": 42, # Target requests per second.
},
- "coolDownPeriod": "A String", # The amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Applies only to the VM runtime.
- "maxTotalInstances": 42, # Max number of instances that App Engine should start to handle requests.
- "maxConcurrentRequests": 42, # The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.
- "minTotalInstances": 42, # Minimum number of instances that App Engine should maintain.
+ "coolDownPeriod": "A String", # Amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
+ "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
+ "maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.
+ "minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
"cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target (0-1) CPU utilization ratio to maintain when scaling.
- "aggregationWindowLength": "A String", # The period of time over which CPU utilization is calculated.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
},
},
- "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set.
"a_key": "A String",
},
- "resources": { # Used to specify how many machine resources an app version needs. # Used to specify how many machine resources an app version needs (for VM runtimes only).
- "diskGb": 3.14, # How much disk size, in GB, an app version needs.
- "cpu": 3.14, # How many CPU cores an app version needs.
- "memoryGb": 3.14, # How much memory, in GB, an app version needs.
+ "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable for VM runtimes.
+ "diskGb": 3.14, # Disk size (GB) needed.
+ "cpu": 3.14, # Number of CPU cores needed.
+ "memoryGb": 3.14, # Memory (GB) needed.
},
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
- "instances": 42, # The number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
+ "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
},
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- "files": { # A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
- "a_key": { # A single source file which is part of the application to be deployed.
- "mimeType": "A String", # The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used.
- "sourceUrl": "A String", # The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
- "sha1Sum": "A String", # The SHA1 (160 bits) hash of the file in hex.
+ "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set.
+ "files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
+ "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
+ "mimeType": "A String", # The MIME type of the file. Defaults to the value from Google Cloud Storage.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
+ "sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
- "sourceReferences": [ # The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.
- { # A reference to a particular snapshot of the source tree used to build and deploy the application.
- "revisionId": "A String", # The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
- "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
+ "sourceReferences": [ # Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.
+ { # Reference to a particular snapshot of the source tree used to build and deploy the application.
+ "revisionId": "A String", # The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
+ "repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # A Docker (container) image which should be used to start the application. # If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime.
- "image": "A String", # Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@digest
+ "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
- "network": { # Used to specify extra network settings (for VM runtimes only). # Used to specify extra network settings (for VM runtimes only).
- "instanceTag": "A String", # A tag to apply to the VM instance during creation.
- "forwardedPorts": [ # A list of ports (or port pairs) to forward from the VM into the app container.
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
"A String",
],
- "name": "A String", # The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named "default" will be used. (The short name should be specified, not the resource path.)
+ "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path. Defaults to `default`.
},
- "nobuildFilesRegex": "A String", # Go only. Files that match this pattern will not be built into the app. May only be set on create requests.
- "name": "A String", # The full path to the Version resource in the API. Example: "apps/myapp/services/default/versions/v1". @OutputOnly
- "handlers": [ # An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
- { # A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
- "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
- "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
- "urlRegex": "A String", # A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required.
- "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches the URL pattern.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes. Only returned in `GET` requests if `view=FULL` is set.
+ "name": "A String", # Full path to the Version resource in the API. Example: `apps/myapp/services/default/versions/v1`. @OutputOnly
+ "handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set.
+ { # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
+ "securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to `redirect`.
+ "urlRegex": "A String", # A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
+ "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches this URL pattern.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
- "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
- "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
- "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
- "requireMatchingFile": True or False, # If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL.
- "uploadPathRegex": "A String", # A regular expression that matches the file paths for all files that will be referenced by this handler.
- "path": "A String", # The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
+ "mimeType": "A String", # MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
+ "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
},
- "apiEndpoint": { # Use Google Cloud Endpoints to handle requests. # Use API Endpoints to handle requests.
- "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
+ "scriptPath": "A String", # Path to the script from the application root directory.
},
- "login": "A String", # What level of login is required to access this resource.
- "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. A `302` is used by default.
+ "login": "A String", # Level of login required to access this resource.
+ "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. Defaults to `302`.
},
],
- "creationTime": "A String", # Creation time of this version. This will be between the start and end times of the operation that creates this version. @OutputOnly
- "servingStatus": "A String", # The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.
- "runtime": "A String", # The desired runtime. Values can include python27, java7, go, etc.
+ "creationTime": "A String", # Time that this version was created. @OutputOnly
+ "servingStatus": "A String", # Current serving status of this version. Only the versions with a `SERVING` status create instances and can be billed. `SERVING_STATUS_UNSPECIFIED` is an invalid value. Defaults to `SERVING`.
+ "runtime": "A String", # Desired runtime. Example: `python27`.
}
mask: string, Standard field mask for the set of fields to be updated.
@@ -825,21 +825,21 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
diff --git a/docs/dyn/appengine_v1beta5.apps.services.versions.instances.html b/docs/dyn/appengine_v1beta5.apps.services.versions.instances.html
index 87d2deb..bbf7545 100644
--- a/docs/dyn/appengine_v1beta5.apps.services.versions.instances.html
+++ b/docs/dyn/appengine_v1beta5.apps.services.versions.instances.html
@@ -75,6 +75,15 @@
<h1><a href="appengine_v1beta5.html">Google App Engine Admin API</a> . <a href="appengine_v1beta5.apps.html">apps</a> . <a href="appengine_v1beta5.apps.services.html">services</a> . <a href="appengine_v1beta5.apps.services.versions.html">versions</a> . <a href="appengine_v1beta5.apps.services.versions.instances.html">instances</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#debug">debug(appsId, servicesId, versionsId, instancesId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</a></code></p>
+<p class="firstline">Stops a running instance.</p>
+<p class="toc_element">
+ <code><a href="#get">get(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets instance information.</p>
+<p class="toc_element">
<code><a href="#list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
<p class="firstline">Lists the instances of a version.</p>
<p class="toc_element">
@@ -82,11 +91,120 @@
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="debug">debug(appsId, servicesId, versionsId, instancesId, body, x__xgafv=None)</code>
+ <pre>Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. (required)
+ servicesId: string, Part of `name`. See documentation of `appsId`. (required)
+ versionsId: string, Part of `name`. See documentation of `appsId`. (required)
+ instancesId: string, Part of `name`. See documentation of `appsId`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request message for `Instances.DebugInstance`.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</code>
+ <pre>Stops a running instance.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default/versions/v1/instances/instance-1". (required)
+ servicesId: string, Part of `name`. See documentation of `appsId`. (required)
+ versionsId: string, Part of `name`. See documentation of `appsId`. (required)
+ instancesId: string, Part of `name`. See documentation of `appsId`. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</code>
+ <pre>Gets instance information.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. (required)
+ servicesId: string, Part of `name`. See documentation of `appsId`. (required)
+ versionsId: string, Part of `name`. See documentation of `appsId`. (required)
+ instancesId: string, Part of `name`. See documentation of `appsId`. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
+ "errors": 42, # Number of errors since this instance was started. @OutputOnly
+ "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. @OutputOnly
+ "startTimestamp": "A String", # Time that this instance was started. @OutputOnly
+ "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
+ "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
+ "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
+ "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
+ "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
+ "requests": 42, # Number of requests since this instance was started. @OutputOnly
+ "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "availability": "A String", # Availability of the instance. @OutputOnly
+ "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</code>
<pre>Lists the instances of a version.
Args:
- appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default/versions/v1". (required)
+ appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/services/default/versions/v1`. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
pageSize: integer, Maximum results to return per page.
@@ -99,22 +217,22 @@
{ # Response message for `Instances.ListInstances`.
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
"instances": [ # The instances belonging to the requested version.
- { # Instances are the computing units that App Engine uses to automatically scale an application.
- "errors": 42, # Number of errors since the instance was started. @OutputOnly
- "name": "A String", # The full path to the Instance resource in the API. Example: "apps/myapp/services/default/versions/v1/instances/instance-1" @OutputOnly
- "startTimestamp": "A String", # Time when instance was started. @OutputOnly
- "appEngineRelease": "A String", # The App Engine release the instance is running on. @OutputOnly
- "vmId": "A String", # For VMEngines instances, the GCE VM ID of the instance. @OutputOnly
- "memoryUsage": "A String", # Memory usage (in bytes). @OutputOnly
- "id": "A String", # The relative name/path of the instance within the version. Example: "instance-1" @OutputOnly
- "vmUnlocked": True or False, # For VMEngines instances, whether the instance has been unlocked. @OutputOnly
- "averageLatency": 42, # Latency in milliseconds (averaged over the last minute). @OutputOnly
- "qps": 3.14, # QPS for this instance (averaged over the last minute). @OutputOnly
- "requests": 42, # Number of requests (since the clone was started). @OutputOnly
- "vmName": "A String", # For VMEngines instances, the name of GCE VM where the instance lives. @OutputOnly
- "availability": "A String", # Availability of instance. @OutputOnly
- "vmZoneName": "A String", # For VMEngines instances, the zone where the GCE VM is located. @OutputOnly
- "vmStatus": "A String", # For VMEngines instances, the status of GCE VM where the instance lives. @OutputOnly
+ { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
+ "errors": 42, # Number of errors since this instance was started. @OutputOnly
+ "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/services/default/versions/v1/instances/instance-1`. @OutputOnly
+ "startTimestamp": "A String", # Time that this instance was started. @OutputOnly
+ "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
+ "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
+ "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
+ "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
+ "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
+ "requests": 42, # Number of requests since this instance was started. @OutputOnly
+ "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "availability": "A String", # Availability of the instance. @OutputOnly
+ "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
+ "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
},
],
}</pre>
diff --git a/docs/dyn/audit_v1.activities.html b/docs/dyn/audit_v1.activities.html
deleted file mode 100644
index a869ae5..0000000
--- a/docs/dyn/audit_v1.activities.html
+++ /dev/null
@@ -1,141 +0,0 @@
-<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="audit_v1.html">Enterprise Audit API</a> . <a href="audit_v1.activities.html">activities</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(customerId, applicationId, caller=None, startTime=None, actorIpAddress=None, eventName=None, actorApplicationId=None, continuationToken=None, maxResults=None, actorEmail=None, endTime=None)</a></code></p>
-<p class="firstline">Retrieves a list of activities for a specific customer and application.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(customerId, applicationId, caller=None, startTime=None, actorIpAddress=None, eventName=None, actorApplicationId=None, continuationToken=None, maxResults=None, actorEmail=None, endTime=None)</code>
- <pre>Retrieves a list of activities for a specific customer and application.
-
-Args:
- customerId: string, Represents the customer who is the owner of target object on which action was performed. (required)
- applicationId: string, Application ID of the application on which the event was performed. (required)
- caller: string, Type of the caller.
- Allowed values
- application_owner - Caller is an application owner.
- customer - Caller is a customer.
- startTime: string, Return events which occured at or after this time.
- actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
- eventName: string, Name of the event being queried.
- actorApplicationId: string, Application ID of the application which interacted on behalf of the user while performing the event.
- continuationToken: string, Next page URL.
- maxResults: integer, Number of activity records to be shown in each page.
- actorEmail: string, Email address of the user who performed the action.
- endTime: string, Return events which occured at or before this time.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # Each record in read response.
- {
- "kind": "audit#activity", # Kind of resource this is.
- "ownerDomain": "A String", # Domain of source customer.
- "actor": { # User doing the action.
- "applicationId": "A String", # ID of application which interacted on behalf 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.
- "uniqQualifier": "A String", # Unique qualifier if multiple events have the same time.
- "applicationId": "A String", # Application ID of the source application.
- "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.
- {
- "eventType": "A String", # Type of event.
- "name": "A String", # Name of event.
- "parameters": [ # Event parameters.
- {
- "name": "A String", # Name of the parameter.
- "value": "A String", # Value of the parameter.
- },
- ],
- },
- ],
- },
- ],
- "kind": "audit#activities", # Kind of list response this is.
- "next": "A String", # Next page URL.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/audit_v1.html b/docs/dyn/audit_v1.html
deleted file mode 100644
index 13aa956..0000000
--- a/docs/dyn/audit_v1.html
+++ /dev/null
@@ -1,82 +0,0 @@
-<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="audit_v1.html">Enterprise Audit API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="audit_v1.activities.html">activities()</a></code>
-</p>
-<p class="firstline">Returns the activities Resource.</p>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/autoscaler_v1beta2.autoscalers.html b/docs/dyn/autoscaler_v1beta2.autoscalers.html
deleted file mode 100644
index f568a12..0000000
--- a/docs/dyn/autoscaler_v1beta2.autoscalers.html
+++ /dev/null
@@ -1,527 +0,0 @@
-<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="autoscaler_v1beta2.html">Google Compute Engine Autoscaler API</a> . <a href="autoscaler_v1beta2.autoscalers.html">autoscalers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(project, zone, autoscaler)</a></code></p>
-<p class="firstline">Deletes the specified Autoscaler resource.</p>
-<p class="toc_element">
- <code><a href="#get">get(project, zone, autoscaler)</a></code></p>
-<p class="firstline">Gets the specified Autoscaler resource.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(project, zone, body)</a></code></p>
-<p class="firstline">Adds new Autoscaler 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">Lists all Autoscaler resources in this 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>
-<p class="toc_element">
- <code><a href="#patch">patch(project, zone, autoscaler, body)</a></code></p>
-<p class="firstline">Update the entire content of the Autoscaler resource. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(project, zone, autoscaler, body)</a></code></p>
-<p class="firstline">Update the entire content of the Autoscaler resource.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(project, zone, autoscaler)</code>
- <pre>Deletes the specified Autoscaler resource.
-
-Args:
- project: string, Project ID of Autoscaler resource. (required)
- zone: string, Zone name of Autoscaler resource. (required)
- autoscaler: string, Name of the Autoscaler resource. (required)
-
-Returns:
- An object of the form:
-
- {
- "targetId": "A String",
- "clientOperationId": "A String",
- "creationTimestamp": "A String",
- "id": "A String",
- "zone": "A String",
- "insertTime": "A String",
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
- "statusMessage": "A String",
- "status": "A String",
- "description": "A String",
- "warnings": [
- {
- "message": "A String",
- "code": "A String",
- "data": [
- {
- "value": "A String",
- "key": "A String",
- },
- ],
- },
- ],
- "user": "A String",
- "startTime": "A String",
- "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String",
- "region": "A String",
- "error": {
- "errors": [
- {
- "message": "A String",
- "code": "A String",
- "location": "A String",
- },
- ],
- },
- "endTime": "A String",
- "selfLink": "A String",
- "targetLink": "A String",
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(project, zone, autoscaler)</code>
- <pre>Gets the specified Autoscaler resource.
-
-Args:
- project: string, Project ID of Autoscaler resource. (required)
- zone: string, Zone name of Autoscaler resource. (required)
- autoscaler: string, Name of the Autoscaler resource. (required)
-
-Returns:
- An object of the form:
-
- { # Cloud Autoscaler resource.
- "kind": "compute#autoscaler", # Type of resource.
- "description": "A String", # An optional textual description of the resource provided by the client.
- "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
- "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
- "coolDownPeriodSec": 42, # The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.
- "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
- "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.
- },
- "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
- { # Custom utilization metric policy.
- "metric": "A String", # Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count.
- "utilizationTargetType": "A String", # Defines type in which utilization_target is expressed.
- "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
- },
- ],
- "cpuUtilization": { # CPU utilization policy. # Configuration parameters of CPU based autoscaling policy.
- "utilizationTarget": 3.14, # The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.
- },
- "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
- },
- "target": "A String", # URL to the entity which will be autoscaled. Currently the only supported value is ReplicaPool?s URL. Note: it is illegal to specify multiple Autoscalers for the same target.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
- "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(project, zone, body)</code>
- <pre>Adds new Autoscaler resource.
-
-Args:
- project: string, Project ID of Autoscaler resource. (required)
- zone: string, Zone name of Autoscaler resource. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Cloud Autoscaler resource.
- "kind": "compute#autoscaler", # Type of resource.
- "description": "A String", # An optional textual description of the resource provided by the client.
- "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
- "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
- "coolDownPeriodSec": 42, # The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.
- "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
- "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.
- },
- "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
- { # Custom utilization metric policy.
- "metric": "A String", # Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count.
- "utilizationTargetType": "A String", # Defines type in which utilization_target is expressed.
- "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
- },
- ],
- "cpuUtilization": { # CPU utilization policy. # Configuration parameters of CPU based autoscaling policy.
- "utilizationTarget": 3.14, # The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.
- },
- "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
- },
- "target": "A String", # URL to the entity which will be autoscaled. Currently the only supported value is ReplicaPool?s URL. Note: it is illegal to specify multiple Autoscalers for the same target.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
- "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "targetId": "A String",
- "clientOperationId": "A String",
- "creationTimestamp": "A String",
- "id": "A String",
- "zone": "A String",
- "insertTime": "A String",
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
- "statusMessage": "A String",
- "status": "A String",
- "description": "A String",
- "warnings": [
- {
- "message": "A String",
- "code": "A String",
- "data": [
- {
- "value": "A String",
- "key": "A String",
- },
- ],
- },
- ],
- "user": "A String",
- "startTime": "A String",
- "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String",
- "region": "A String",
- "error": {
- "errors": [
- {
- "message": "A String",
- "code": "A String",
- "location": "A String",
- },
- ],
- },
- "endTime": "A String",
- "selfLink": "A String",
- "targetLink": "A String",
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all Autoscaler resources in this zone.
-
-Args:
- project: string, Project ID of Autoscaler resource. (required)
- zone: string, Zone name of Autoscaler resource. (required)
- maxResults: integer, A parameter
- pageToken: string, A parameter
- filter: string, A parameter
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # [Output only] A token used to continue a truncated list request.
- "items": [ # Autoscaler resources.
- { # Cloud Autoscaler resource.
- "kind": "compute#autoscaler", # Type of resource.
- "description": "A String", # An optional textual description of the resource provided by the client.
- "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
- "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
- "coolDownPeriodSec": 42, # The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.
- "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
- "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.
- },
- "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
- { # Custom utilization metric policy.
- "metric": "A String", # Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count.
- "utilizationTargetType": "A String", # Defines type in which utilization_target is expressed.
- "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
- },
- ],
- "cpuUtilization": { # CPU utilization policy. # Configuration parameters of CPU based autoscaling policy.
- "utilizationTarget": 3.14, # The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.
- },
- "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
- },
- "target": "A String", # URL to the entity which will be autoscaled. Currently the only supported value is ReplicaPool?s URL. Note: it is illegal to specify multiple Autoscalers for the same target.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
- "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
- },
- ],
- "kind": "compute#autoscalerList", # Type of resource.
- }</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, zone, autoscaler, body)</code>
- <pre>Update the entire content of the Autoscaler resource. This method supports patch semantics.
-
-Args:
- project: string, Project ID of Autoscaler resource. (required)
- zone: string, Zone name of Autoscaler resource. (required)
- autoscaler: string, Name of the Autoscaler resource. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Cloud Autoscaler resource.
- "kind": "compute#autoscaler", # Type of resource.
- "description": "A String", # An optional textual description of the resource provided by the client.
- "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
- "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
- "coolDownPeriodSec": 42, # The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.
- "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
- "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.
- },
- "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
- { # Custom utilization metric policy.
- "metric": "A String", # Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count.
- "utilizationTargetType": "A String", # Defines type in which utilization_target is expressed.
- "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
- },
- ],
- "cpuUtilization": { # CPU utilization policy. # Configuration parameters of CPU based autoscaling policy.
- "utilizationTarget": 3.14, # The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.
- },
- "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
- },
- "target": "A String", # URL to the entity which will be autoscaled. Currently the only supported value is ReplicaPool?s URL. Note: it is illegal to specify multiple Autoscalers for the same target.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
- "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "targetId": "A String",
- "clientOperationId": "A String",
- "creationTimestamp": "A String",
- "id": "A String",
- "zone": "A String",
- "insertTime": "A String",
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
- "statusMessage": "A String",
- "status": "A String",
- "description": "A String",
- "warnings": [
- {
- "message": "A String",
- "code": "A String",
- "data": [
- {
- "value": "A String",
- "key": "A String",
- },
- ],
- },
- ],
- "user": "A String",
- "startTime": "A String",
- "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String",
- "region": "A String",
- "error": {
- "errors": [
- {
- "message": "A String",
- "code": "A String",
- "location": "A String",
- },
- ],
- },
- "endTime": "A String",
- "selfLink": "A String",
- "targetLink": "A String",
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(project, zone, autoscaler, body)</code>
- <pre>Update the entire content of the Autoscaler resource.
-
-Args:
- project: string, Project ID of Autoscaler resource. (required)
- zone: string, Zone name of Autoscaler resource. (required)
- autoscaler: string, Name of the Autoscaler resource. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Cloud Autoscaler resource.
- "kind": "compute#autoscaler", # Type of resource.
- "description": "A String", # An optional textual description of the resource provided by the client.
- "autoscalingPolicy": { # Cloud Autoscaler policy. # Configuration parameters for autoscaling algorithm.
- "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to.
- "coolDownPeriodSec": 42, # The number of seconds that the Autoscaler should wait between two succeeding changes to the number of virtual machines. You should define an interval that is at least as long as the initialization time of a virtual machine and the time it may take for replica pool to create the virtual machine. The default is 60 seconds.
- "loadBalancingUtilization": { # Load balancing utilization policy. # Configuration parameters of autoscaling based on load balancer.
- "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP load balancing configuration) that Autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. For example if your maxRatePerInstance capacity (in HTTP Load Balancing configuration) is set at 10 and you would like to keep number of instances such that each instance receives 7 QPS on average, set this to 0.7.
- },
- "customMetricUtilizations": [ # Configuration parameters of autoscaling based on custom metric.
- { # Custom utilization metric policy.
- "metric": "A String", # Identifier of the metric. It should be a Cloud Monitoring metric. The metric can not have negative values. The metric should be an utilization metric (increasing number of VMs handling requests x times should reduce average value of the metric roughly x times). For example you could use: compute.googleapis.com/instance/network/received_bytes_count.
- "utilizationTargetType": "A String", # Defines type in which utilization_target is expressed.
- "utilizationTarget": 3.14, # Target value of the metric which Autoscaler should maintain. Must be a positive value.
- },
- ],
- "cpuUtilization": { # CPU utilization policy. # Configuration parameters of CPU based autoscaling policy.
- "utilizationTarget": 3.14, # The target utilization that the Autoscaler should maintain. It is represented as a fraction of used cores. For example: 6 cores used in 8-core VM are represented here as 0.75. Must be a float value between (0, 1]. If not defined, the default is 0.8.
- },
- "minNumReplicas": 42, # The minimum number of replicas that the Autoscaler can scale down to.
- },
- "target": "A String", # URL to the entity which will be autoscaled. Currently the only supported value is ReplicaPool?s URL. Note: it is illegal to specify multiple Autoscalers for the same target.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] A self-link to the Autoscaler configuration resource.
- "name": "A String", # Name of the Autoscaler resource. Must be unique per project and zone.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "targetId": "A String",
- "clientOperationId": "A String",
- "creationTimestamp": "A String",
- "id": "A String",
- "zone": "A String",
- "insertTime": "A String",
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
- "statusMessage": "A String",
- "status": "A String",
- "description": "A String",
- "warnings": [
- {
- "message": "A String",
- "code": "A String",
- "data": [
- {
- "value": "A String",
- "key": "A String",
- },
- ],
- },
- ],
- "user": "A String",
- "startTime": "A String",
- "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String",
- "region": "A String",
- "error": {
- "errors": [
- {
- "message": "A String",
- "code": "A String",
- "location": "A String",
- },
- ],
- },
- "endTime": "A String",
- "selfLink": "A String",
- "targetLink": "A String",
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/autoscaler_v1beta2.html b/docs/dyn/autoscaler_v1beta2.html
deleted file mode 100644
index 073c665..0000000
--- a/docs/dyn/autoscaler_v1beta2.html
+++ /dev/null
@@ -1,113 +0,0 @@
-<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="autoscaler_v1beta2.html">Google Compute Engine Autoscaler API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="autoscaler_v1beta2.autoscalers.html">autoscalers()</a></code>
-</p>
-<p class="firstline">Returns the autoscalers Resource.</p>
-
-<p class="toc_element">
- <code><a href="autoscaler_v1beta2.zoneOperations.html">zoneOperations()</a></code>
-</p>
-<p class="firstline">Returns the zoneOperations Resource.</p>
-
-<p class="toc_element">
- <code><a href="autoscaler_v1beta2.zones.html">zones()</a></code>
-</p>
-<p class="firstline">Returns the zones Resource.</p>
-
-<p class="toc_element">
- <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
-<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
- <pre>Create a BatchHttpRequest object based on the discovery document.
-
- Args:
- callback: callable, A callback to be called for each response, of the
- form callback(id, response, exception). The first parameter is the
- request id, and the second is the deserialized response object. The
- third is an apiclient.errors.HttpError exception object if an HTTP
- error occurred while processing the request, or None if no error
- occurred.
-
- Returns:
- A BatchHttpRequest object based on the discovery document.
- </pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/autoscaler_v1beta2.zoneOperations.html b/docs/dyn/autoscaler_v1beta2.zoneOperations.html
deleted file mode 100644
index a96a39e..0000000
--- a/docs/dyn/autoscaler_v1beta2.zoneOperations.html
+++ /dev/null
@@ -1,241 +0,0 @@
-<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="autoscaler_v1beta2.html">Google Compute Engine Autoscaler API</a> . <a href="autoscaler_v1beta2.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, A parameter (required)
- zone: string, A parameter (required)
- operation: string, A parameter (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, A parameter (required)
- zone: string, A parameter (required)
- operation: string, A parameter (required)
-
-Returns:
- An object of the form:
-
- {
- "targetId": "A String",
- "clientOperationId": "A String",
- "creationTimestamp": "A String",
- "id": "A String",
- "zone": "A String",
- "insertTime": "A String",
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
- "statusMessage": "A String",
- "status": "A String",
- "description": "A String",
- "warnings": [
- {
- "message": "A String",
- "code": "A String",
- "data": [
- {
- "value": "A String",
- "key": "A String",
- },
- ],
- },
- ],
- "user": "A String",
- "startTime": "A String",
- "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String",
- "region": "A String",
- "error": {
- "errors": [
- {
- "message": "A String",
- "code": "A String",
- "location": "A String",
- },
- ],
- },
- "endTime": "A String",
- "selfLink": "A String",
- "targetLink": "A String",
- }</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, A parameter (required)
- zone: string, A parameter (required)
- maxResults: integer, A parameter
- pageToken: string, A parameter
- filter: string, A parameter
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String",
- "items": [
- {
- "targetId": "A String",
- "clientOperationId": "A String",
- "creationTimestamp": "A String",
- "id": "A String",
- "zone": "A String",
- "insertTime": "A String",
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
- "statusMessage": "A String",
- "status": "A String",
- "description": "A String",
- "warnings": [
- {
- "message": "A String",
- "code": "A String",
- "data": [
- {
- "value": "A String",
- "key": "A String",
- },
- ],
- },
- ],
- "user": "A String",
- "startTime": "A String",
- "kind": "autoscaler#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String",
- "region": "A String",
- "error": {
- "errors": [
- {
- "message": "A String",
- "code": "A String",
- "location": "A String",
- },
- ],
- },
- "endTime": "A String",
- "selfLink": "A String",
- "targetLink": "A String",
- },
- ],
- "kind": "autoscaler#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
- "id": "A String",
- "selfLink": "A String",
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/autoscaler_v1beta2.zones.html b/docs/dyn/autoscaler_v1beta2.zones.html
deleted file mode 100644
index 6198a78..0000000
--- a/docs/dyn/autoscaler_v1beta2.zones.html
+++ /dev/null
@@ -1,138 +0,0 @@
-<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="autoscaler_v1beta2.html">Google Compute Engine Autoscaler API</a> . <a href="autoscaler_v1beta2.zones.html">zones</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(maxResults=None, project=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline"></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(maxResults=None, project=None, pageToken=None, filter=None)</code>
- <pre>
-
-Args:
- maxResults: integer, A parameter
- project: string, A parameter
- pageToken: string, A parameter
- filter: string, A parameter
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String",
- "items": [
- {
- "status": "A String",
- "kind": "autoscaler#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
- "description": "A String",
- "deprecated": {
- "deleted": "A String",
- "deprecated": "A String",
- "state": "A String",
- "obsolete": "A String",
- "replacement": "A String",
- },
- "region": "A String",
- "creationTimestamp": "A String",
- "id": "A String",
- "selfLink": "A String",
- "name": "A String",
- },
- ],
- "kind": "autoscaler#zoneList", # Type of resource.
- "id": "A String",
- "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html
index c0bfb55..647b13c 100644
--- a/docs/dyn/bigquery_v2.jobs.html
+++ b/docs/dyn/bigquery_v2.jobs.html
@@ -270,43 +270,10 @@
],
},
},
- "extract": { # [Pick one] Configures an extract job.
- "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
- "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
- "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
- "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
- "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- "A String",
- ],
- "sourceTable": { # [Required] A reference to the table being exported.
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- },
- "copy": { # [Pick one] Copies a table.
- "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- "sourceTables": [ # [Pick one] Source tables to copy.
- {
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- ],
- "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- "destinationTable": { # [Required] The destination table
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- "sourceTable": { # [Pick one] Source table to copy.
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- },
"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.
+ "labels": { # [Experimental] The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
+ "a_key": "A String",
+ },
"query": { # [Pick one] Configures a query job.
"flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.
"maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
@@ -321,7 +288,7 @@
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
},
- "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
"A String",
],
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
@@ -333,7 +300,7 @@
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
},
],
- "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
+ "queryParameters": [ # Query parameters for standard SQL queries.
{
"parameterType": { # [Required] The type of this parameter.
"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
@@ -422,6 +389,42 @@
},
"parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
},
+ "copy": { # [Pick one] Copies a table.
+ "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
+ "sourceTables": [ # [Pick one] Source tables to copy.
+ {
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ ],
+ "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
+ "destinationTable": { # [Required] The destination table
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ "sourceTable": { # [Pick one] Source table to copy.
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ },
+ "extract": { # [Pick one] Configures an extract job.
+ "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
+ "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
+ "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
+ "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
+ "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
+ "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
+ "A String",
+ ],
+ "sourceTable": { # [Required] A reference to the table being exported.
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ },
},
"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.
@@ -603,43 +606,10 @@
],
},
},
- "extract": { # [Pick one] Configures an extract job.
- "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
- "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
- "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
- "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
- "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- "A String",
- ],
- "sourceTable": { # [Required] A reference to the table being exported.
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- },
- "copy": { # [Pick one] Copies a table.
- "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- "sourceTables": [ # [Pick one] Source tables to copy.
- {
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- ],
- "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- "destinationTable": { # [Required] The destination table
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- "sourceTable": { # [Pick one] Source table to copy.
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- },
"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.
+ "labels": { # [Experimental] The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
+ "a_key": "A String",
+ },
"query": { # [Pick one] Configures a query job.
"flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.
"maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
@@ -654,7 +624,7 @@
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
},
- "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
"A String",
],
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
@@ -666,7 +636,7 @@
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
},
],
- "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
+ "queryParameters": [ # Query parameters for standard SQL queries.
{
"parameterType": { # [Required] The type of this parameter.
"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
@@ -755,6 +725,42 @@
},
"parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
},
+ "copy": { # [Pick one] Copies a table.
+ "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
+ "sourceTables": [ # [Pick one] Source tables to copy.
+ {
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ ],
+ "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
+ "destinationTable": { # [Required] The destination table
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ "sourceTable": { # [Pick one] Source table to copy.
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ },
+ "extract": { # [Pick one] Configures an extract job.
+ "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
+ "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
+ "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
+ "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
+ "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
+ "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
+ "A String",
+ ],
+ "sourceTable": { # [Required] A reference to the table being exported.
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ },
},
"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.
@@ -993,43 +999,10 @@
],
},
},
- "extract": { # [Pick one] Configures an extract job.
- "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
- "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
- "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
- "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
- "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- "A String",
- ],
- "sourceTable": { # [Required] A reference to the table being exported.
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- },
- "copy": { # [Pick one] Copies a table.
- "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- "sourceTables": [ # [Pick one] Source tables to copy.
- {
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- ],
- "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- "destinationTable": { # [Required] The destination table
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- "sourceTable": { # [Pick one] Source table to copy.
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- },
"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.
+ "labels": { # [Experimental] The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
+ "a_key": "A String",
+ },
"query": { # [Pick one] Configures a query job.
"flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.
"maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
@@ -1044,7 +1017,7 @@
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
},
- "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
"A String",
],
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
@@ -1056,7 +1029,7 @@
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
},
],
- "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
+ "queryParameters": [ # Query parameters for standard SQL queries.
{
"parameterType": { # [Required] The type of this parameter.
"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
@@ -1145,6 +1118,42 @@
},
"parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
},
+ "copy": { # [Pick one] Copies a table.
+ "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
+ "sourceTables": [ # [Pick one] Source tables to copy.
+ {
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ ],
+ "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
+ "destinationTable": { # [Required] The destination table
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ "sourceTable": { # [Pick one] Source table to copy.
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ },
+ "extract": { # [Pick one] Configures an extract job.
+ "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
+ "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
+ "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
+ "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
+ "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
+ "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
+ "A String",
+ ],
+ "sourceTable": { # [Required] A reference to the table being exported.
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ },
},
"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.
@@ -1317,43 +1326,10 @@
],
},
},
- "extract": { # [Pick one] Configures an extract job.
- "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
- "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
- "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
- "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
- "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- "A String",
- ],
- "sourceTable": { # [Required] A reference to the table being exported.
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- },
- "copy": { # [Pick one] Copies a table.
- "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- "sourceTables": [ # [Pick one] Source tables to copy.
- {
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- ],
- "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- "destinationTable": { # [Required] The destination table
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- "sourceTable": { # [Pick one] Source table to copy.
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- },
"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.
+ "labels": { # [Experimental] The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
+ "a_key": "A String",
+ },
"query": { # [Pick one] Configures a query job.
"flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.
"maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
@@ -1368,7 +1344,7 @@
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
},
- "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
"A String",
],
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
@@ -1380,7 +1356,7 @@
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
},
],
- "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
+ "queryParameters": [ # Query parameters for standard SQL queries.
{
"parameterType": { # [Required] The type of this parameter.
"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
@@ -1469,6 +1445,42 @@
},
"parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
},
+ "copy": { # [Pick one] Copies a table.
+ "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
+ "sourceTables": [ # [Pick one] Source tables to copy.
+ {
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ ],
+ "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
+ "destinationTable": { # [Required] The destination table
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ "sourceTable": { # [Pick one] Source table to copy.
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ },
+ "extract": { # [Pick one] Configures an extract job.
+ "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
+ "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
+ "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
+ "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
+ "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
+ "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
+ "A String",
+ ],
+ "sourceTable": { # [Required] A reference to the table being exported.
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ },
},
"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.
@@ -1664,43 +1676,10 @@
],
},
},
- "extract": { # [Pick one] Configures an extract job.
- "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
- "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
- "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
- "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
- "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- "A String",
- ],
- "sourceTable": { # [Required] A reference to the table being exported.
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- },
- "copy": { # [Pick one] Copies a table.
- "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- "sourceTables": [ # [Pick one] Source tables to copy.
- {
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- ],
- "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- "destinationTable": { # [Required] The destination table
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- "sourceTable": { # [Pick one] Source table to copy.
- "projectId": "A String", # [Required] The ID of the project containing this table.
- "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this table.
- },
- },
"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.
+ "labels": { # [Experimental] The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be <= 128 bytes in size.
+ "a_key": "A String",
+ },
"query": { # [Pick one] Configures a query job.
"flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.
"maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
@@ -1715,7 +1694,7 @@
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
},
- "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
"A String",
],
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
@@ -1727,7 +1706,7 @@
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
},
],
- "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
+ "queryParameters": [ # Query parameters for standard SQL queries.
{
"parameterType": { # [Required] The type of this parameter.
"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
@@ -1816,6 +1795,42 @@
},
"parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
},
+ "copy": { # [Pick one] Copies a table.
+ "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
+ "sourceTables": [ # [Pick one] Source tables to copy.
+ {
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ ],
+ "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
+ "destinationTable": { # [Required] The destination table
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ "sourceTable": { # [Pick one] Source table to copy.
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ },
+ "extract": { # [Pick one] Configures an extract job.
+ "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
+ "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE.
+ "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
+ "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
+ "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true.
+ "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
+ "A String",
+ ],
+ "sourceTable": { # [Required] A reference to the table being exported.
+ "projectId": "A String", # [Required] The ID of the project containing this table.
+ "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this table.
+ },
+ },
},
"id": "A String", # Unique opaque ID of the job.
"errorResult": { # A result object that will be present only if the job has failed.
diff --git a/docs/dyn/blogger_v2.blogs.html b/docs/dyn/blogger_v2.blogs.html
new file mode 100644
index 0000000..7843c69
--- /dev/null
+++ b/docs/dyn/blogger_v2.blogs.html
@@ -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="blogger_v2.html">Blogger API</a> . <a href="blogger_v2.blogs.html">blogs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(blogId)</a></code></p>
+<p class="firstline">Gets one blog by id.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(blogId)</code>
+ <pre>Gets one blog by id.
+
+Args:
+ blogId: string, The ID of the blog to get. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "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.
+ "selfLink": "A String", # The URL of the container for posts in this blog.
+ },
+ "updated": "A String", # RFC 3339 date-time when this blog was last updated.
+ "id": "A String", # The identifier for this resource.
+ "url": "A String", # The URL where this blog is published.
+ "published": "A String", # RFC 3339 date-time when this blog was published.
+ "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.
+ },
+ "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.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/blogger_v2.comments.html b/docs/dyn/blogger_v2.comments.html
new file mode 100644
index 0000000..b96fdfb
--- /dev/null
+++ b/docs/dyn/blogger_v2.comments.html
@@ -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="blogger_v2.html">Blogger API</a> . <a href="blogger_v2.comments.html">comments</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(blogId, postId, commentId)</a></code></p>
+<p class="firstline">Gets one comment by id.</p>
+<p class="toc_element">
+ <code><a href="#list">list(blogId, postId, startDate=None, fetchBodies=None, pageToken=None, maxResults=None)</a></code></p>
+<p class="firstline">Retrieves the comments for a blog, possibly filtered.</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(blogId, postId, commentId)</code>
+ <pre>Gets one comment by id.
+
+Args:
+ blogId: string, ID of the blog to containing the comment. (required)
+ postId: string, ID of the post to fetch posts from. (required)
+ commentId: string, The ID of the comment to get. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "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.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(blogId, postId, startDate=None, fetchBodies=None, pageToken=None, maxResults=None)</code>
+ <pre>Retrieves the comments for a blog, possibly filtered.
+
+Args:
+ blogId: string, ID of the blog to fetch comments from. (required)
+ postId: string, ID of the post to fetch posts from. (required)
+ startDate: string, Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
+ fetchBodies: boolean, Whether the body content of the comments is included.
+ pageToken: string, Continuation token if request is paged.
+ maxResults: integer, Maximum number of comments to include in the result.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
+ "items": [ # The List of Comments for a 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.
+ },
+ ],
+ "kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
+ "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/computeaccounts_alpha.html b/docs/dyn/blogger_v2.html
similarity index 77%
copy from docs/dyn/computeaccounts_alpha.html
copy to docs/dyn/blogger_v2.html
index 938942e..0e1ceb70 100644
--- a/docs/dyn/computeaccounts_alpha.html
+++ b/docs/dyn/blogger_v2.html
@@ -72,25 +72,30 @@
</style>
-<h1><a href="computeaccounts_alpha.html">Compute Accounts API</a></h1>
+<h1><a href="blogger_v2.html">Blogger API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.globalAccountsOperations.html">globalAccountsOperations()</a></code>
+ <code><a href="blogger_v2.blogs.html">blogs()</a></code>
</p>
-<p class="firstline">Returns the globalAccountsOperations Resource.</p>
+<p class="firstline">Returns the blogs Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.groups.html">groups()</a></code>
+ <code><a href="blogger_v2.comments.html">comments()</a></code>
</p>
-<p class="firstline">Returns the groups Resource.</p>
+<p class="firstline">Returns the comments Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.linux.html">linux()</a></code>
+ <code><a href="blogger_v2.pages.html">pages()</a></code>
</p>
-<p class="firstline">Returns the linux Resource.</p>
+<p class="firstline">Returns the pages Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.users.html">users()</a></code>
+ <code><a href="blogger_v2.posts.html">posts()</a></code>
+</p>
+<p class="firstline">Returns the posts Resource.</p>
+
+<p class="toc_element">
+ <code><a href="blogger_v2.users.html">users()</a></code>
</p>
<p class="firstline">Returns the users Resource.</p>
diff --git a/docs/dyn/blogger_v2.pages.html b/docs/dyn/blogger_v2.pages.html
new file mode 100644
index 0000000..bf45bd3
--- /dev/null
+++ b/docs/dyn/blogger_v2.pages.html
@@ -0,0 +1,157 @@
+<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_v2.html">Blogger API</a> . <a href="blogger_v2.pages.html">pages</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(blogId, pageId)</a></code></p>
+<p class="firstline">Gets one blog page by id.</p>
+<p class="toc_element">
+ <code><a href="#list">list(blogId, fetchBodies=None)</a></code></p>
+<p class="firstline">Retrieves pages for a blog, possibly filtered.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(blogId, pageId)</code>
+ <pre>Gets one blog page by id.
+
+Args:
+ blogId: string, ID of the blog containing the page. (required)
+ pageId: string, The ID of the page to get. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "content": "A String", # The body content of this Page, in HTML.
+ "kind": "blogger#page", # The kind of this entity. Always blogger#page
+ "author": { # The author of this Page.
+ "url": "A String", # The URL of the Page creator's Profile page.
+ "image": { # The page author's avatar.
+ "url": "A String", # The page author's avatar URL.
+ },
+ "displayName": "A String", # The display name.
+ "id": "A String", # The identifier of the Page creator.
+ },
+ "url": "A String", # The URL that this Page is displayed at.
+ "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
+ "updated": "A String", # RFC 3339 date-time when this Page was last updated.
+ "blog": { # Data about the blog containing this Page.
+ "id": "A String", # The identifier of the blog containing this page.
+ },
+ "published": "A String", # RFC 3339 date-time when this Page was published.
+ "id": "A String", # The identifier for this resource.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(blogId, fetchBodies=None)</code>
+ <pre>Retrieves pages for a blog, possibly filtered.
+
+Args:
+ blogId: string, ID of the blog to fetch pages from. (required)
+ fetchBodies: boolean, Whether to retrieve the Page bodies.
+
+Returns:
+ An object of the form:
+
+ {
+ "items": [ # The list of Pages for a Blog.
+ {
+ "content": "A String", # The body content of this Page, in HTML.
+ "kind": "blogger#page", # The kind of this entity. Always blogger#page
+ "author": { # The author of this Page.
+ "url": "A String", # The URL of the Page creator's Profile page.
+ "image": { # The page author's avatar.
+ "url": "A String", # The page author's avatar URL.
+ },
+ "displayName": "A String", # The display name.
+ "id": "A String", # The identifier of the Page creator.
+ },
+ "url": "A String", # The URL that this Page is displayed at.
+ "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
+ "updated": "A String", # RFC 3339 date-time when this Page was last updated.
+ "blog": { # Data about the blog containing this Page.
+ "id": "A String", # The identifier of the blog containing this page.
+ },
+ "published": "A String", # RFC 3339 date-time when this Page was published.
+ "id": "A String", # The identifier for this resource.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ },
+ ],
+ "kind": "blogger#pageList", # The kind of this entity. Always blogger#pageList
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/blogger_v2.posts.html b/docs/dyn/blogger_v2.posts.html
new file mode 100644
index 0000000..fabb3de
--- /dev/null
+++ b/docs/dyn/blogger_v2.posts.html
@@ -0,0 +1,193 @@
+<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_v2.html">Blogger API</a> . <a href="blogger_v2.posts.html">posts</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(blogId, postId)</a></code></p>
+<p class="firstline">Get a post by id.</p>
+<p class="toc_element">
+ <code><a href="#list">list(blogId, startDate=None, pageToken=None, maxResults=None, fetchBodies=None)</a></code></p>
+<p class="firstline">Retrieves a list of posts, possibly filtered.</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(blogId, postId)</code>
+ <pre>Get a post by id.
+
+Args:
+ blogId: string, ID of the blog to fetch the post from. (required)
+ postId: string, The ID of the post (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "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.
+ "selfLink": "A String", # The URL of the comments on this post.
+ },
+ "labels": [ # The list of labels this Post was tagged with.
+ "A String",
+ ],
+ "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.
+ "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.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(blogId, startDate=None, pageToken=None, maxResults=None, fetchBodies=None)</code>
+ <pre>Retrieves a list of posts, possibly filtered.
+
+Args:
+ blogId: string, ID of the blog to fetch posts from. (required)
+ startDate: string, Earliest post date to fetch, a date-time with RFC 3339 formatting.
+ pageToken: string, Continuation token if the request is paged.
+ maxResults: integer, Maximum number of posts to fetch.
+ fetchBodies: boolean, Whether the body content of posts is included.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
+ "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.
+ "selfLink": "A String", # The URL of the comments on this post.
+ },
+ "labels": [ # The list of labels this Post was tagged with.
+ "A String",
+ ],
+ "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.
+ "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.
+ },
+ ],
+ "kind": "blogger#postList", # The kind of this entity. Always blogger#postList
+ "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/blogger_v2.users.blogs.html b/docs/dyn/blogger_v2.users.blogs.html
new file mode 100644
index 0000000..58166b4
--- /dev/null
+++ b/docs/dyn/blogger_v2.users.blogs.html
@@ -0,0 +1,121 @@
+<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_v2.html">Blogger API</a> . <a href="blogger_v2.users.html">users</a> . <a href="blogger_v2.users.blogs.html">blogs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(userId)</a></code></p>
+<p class="firstline">Retrieves a list of blogs, possibly filtered.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(userId)</code>
+ <pre>Retrieves a list of blogs, possibly filtered.
+
+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)
+
+Returns:
+ An object of the form:
+
+ {
+ "items": [ # The list of Blogs this user has Authorship or Admin rights over.
+ {
+ "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.
+ "selfLink": "A String", # The URL of the container for posts in this blog.
+ },
+ "updated": "A String", # RFC 3339 date-time when this blog was last updated.
+ "id": "A String", # The identifier for this resource.
+ "url": "A String", # The URL where this blog is published.
+ "published": "A String", # RFC 3339 date-time when this blog was published.
+ "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.
+ },
+ "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#blogList", # The kind of this entity. Always blogger#blogList
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/blogger_v2.users.html b/docs/dyn/blogger_v2.users.html
new file mode 100644
index 0000000..b719712
--- /dev/null
+++ b/docs/dyn/blogger_v2.users.html
@@ -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="blogger_v2.html">Blogger API</a> . <a href="blogger_v2.users.html">users</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="blogger_v2.users.blogs.html">blogs()</a></code>
+</p>
+<p class="firstline">Returns the blogs Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#get">get(userId)</a></code></p>
+<p class="firstline">Gets one user by id.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(userId)</code>
+ <pre>Gets one user by id.
+
+Args:
+ userId: string, The ID of the user to get. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "about": "A String", # Profile summary information.
+ "displayName": "A String", # The display name.
+ "created": "A String", # The timestamp of when this profile was created, in seconds since epoch.
+ "locale": { # This user's locale
+ "country": "A String", # The user's country setting.
+ "variant": "A String", # The user's language variant setting.
+ "language": "A String", # The user's language setting.
+ },
+ "blogs": { # The container of blogs for this user.
+ "selfLink": "A String", # The URL of the Blogs for this user.
+ },
+ "kind": "blogger#user", # The kind of this entity. Always blogger#user
+ "url": "A String", # The user's profile page.
+ "id": "A String", # The identifier for this User.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/civicinfo_us_v1.divisions.html b/docs/dyn/civicinfo_us_v1.divisions.html
deleted file mode 100644
index 0b43812..0000000
--- a/docs/dyn/civicinfo_us_v1.divisions.html
+++ /dev/null
@@ -1,103 +0,0 @@
-<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="civicinfo_us_v1.html">Google Civic Information API</a> . <a href="civicinfo_us_v1.divisions.html">divisions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#search">search(query=None)</a></code></p>
-<p class="firstline">Searches for political divisions by their natural name or OCD ID.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="search">search(query=None)</code>
- <pre>Searches for political divisions by their natural name or OCD ID.
-
-Args:
- query: string, The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html
-
-Returns:
- An object of the form:
-
- { # The result of a division search query.
- "status": "A String", # The result of the request. One of: success, addressUnparseable, noAddressParameter, internalLookupFailure
- "kind": "civicinfo#divisionSearchResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#divisionSearchResponse".
- "results": [
- { # Represents a political geographic division that matches the requested query.
- "ocdId": "A String", # The unique Open Civic Data identifier for this division.
- "name": "A String", # The name of the division.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/civicinfo_us_v1.elections.html b/docs/dyn/civicinfo_us_v1.elections.html
deleted file mode 100644
index 35744e3..0000000
--- a/docs/dyn/civicinfo_us_v1.elections.html
+++ /dev/null
@@ -1,294 +0,0 @@
-<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="civicinfo_us_v1.html">Google Civic Information API</a> . <a href="civicinfo_us_v1.elections.html">elections</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#electionQuery">electionQuery()</a></code></p>
-<p class="firstline">List of available elections to query.</p>
-<p class="toc_element">
- <code><a href="#voterInfoQuery">voterInfoQuery(electionId, body, officialOnly=None)</a></code></p>
-<p class="firstline">Looks up information relevant to a voter based on the voter's registered address.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="electionQuery">electionQuery()</code>
- <pre>List of available elections to query.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # The list of elections available for this version of the API.
- "kind": "civicinfo#electionsQueryResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse".
- "elections": [ # A list of available elections
- { # Information about the election that was queried.
- "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
- "id": "A String", # The unique ID of this election.
- "name": "A String", # A displayable name for the election.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="voterInfoQuery">voterInfoQuery(electionId, body, officialOnly=None)</code>
- <pre>Looks up information relevant to a voter based on the voter's registered address.
-
-Args:
- electionId: string, The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/elections (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A request for information about a voter.
- "address": "A String", # The registered address of the voter to look up.
- }
-
- officialOnly: boolean, If set to true, only data from official state sources will be returned.
-
-Returns:
- An object of the form:
-
- { # The result of a voter info lookup query.
- "status": "A String", # The result of the request. One of: success, noStreetSegmentFound, addressUnparseable, noAddressParameter, multipleStreetSegmentsFound, electionOver, electionUnknown, internalLookupFailure
- "earlyVoteSites": [ # Locations where the voter is eligible to vote early, prior to election day
- { # A location where a voter can vote. This may be an early vote site or an election day voting location.
- "startDate": "A String", # The first date that this early vote site may be used. This field is not populated for polling locations.
- "pollingHours": "A String", # A description of when this location is open.
- "endDate": "A String", # The last date that this early vote site may be used. This field is not populated for polling locations.
- "name": "A String", # The name of the early vote site. This field is not populated for polling locations.
- "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use)
- "voterServices": "A String", # The services provided by this early vote site. This field is not populated for polling locations.
- "sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "address": { # A simple representation of an address. # The address of the location
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "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.
- },
- ],
- "kind": "civicinfo#voterInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse".
- "normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "state": [ # Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.
- { # Describes information about a regional election administrative area.
- "local_jurisdiction": # Object with schema name: AdministrationRegion # The city or county that provides election information for this voter. This object can have the same elements as state.
- "sources": [ # A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "electionAdministrationBody": { # Information about an election administrative body (e.g. County Board of Elections). # The election administration body for this area.
- "absenteeVotingInfoUrl": "A String", # A URL provided by this administrative body for information on absentee voting.
- "votingLocationFinderUrl": "A String", # A URL provided by this administrative body for looking up where to vote.
- "name": "A String", # The name of this election administrative body.
- "electionRegistrationConfirmationUrl": "A String", # A URL provided by this administrative body for confirming that the voter is registered to vote.
- "correspondenceAddress": { # A simple representation of an address. # The mailing address of this administrative body.
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "electionRegistrationUrl": "A String", # A URL provided by this administrative body for looking up how to register to vote.
- "electionOfficials": [ # The election officials for this election administrative body.
- { # Information about individual election officials.
- "title": "A String", # The title of the election official.
- "emailAddress": "A String", # The email address of the election official.
- "name": "A String", # The full name of the election official.
- "officePhoneNumber": "A String", # The office phone number of the election official.
- "faxNumber": "A String", # The fax number of the election official.
- },
- ],
- "electionInfoUrl": "A String", # A URL provided by this administrative body for looking up general election information.
- "electionRulesUrl": "A String", # A URL provided by this administrative body describing election rules to the voter.
- "voter_services": [ # A description of the services this administrative body may provide.
- "A String",
- ],
- "ballotInfoUrl": "A String", # A URL provided by this administrative body to give contest information to the voter.
- "hoursOfOperation": "A String", # A description of the hours of operation for this administrative body.
- "physicalAddress": { # A simple representation of an address. # The physical address of this administrative body.
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- },
- "name": "A String", # The name of the jurisdiction.
- "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.
- },
- ],
- "election": { # Information about the election that was queried. # The election that was queried.
- "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
- "id": "A String", # The unique ID of this election.
- "name": "A String", # A displayable name for the election.
- },
- "pollingLocations": [ # Locations where the voter is eligible to vote on election day. For states with mail-in voting only, these locations will be nearby drop box locations. Drop box locations are free to the voter and may be used instead of placing the ballot in the mail.
- { # A location where a voter can vote. This may be an early vote site or an election day voting location.
- "startDate": "A String", # The first date that this early vote site may be used. This field is not populated for polling locations.
- "pollingHours": "A String", # A description of when this location is open.
- "endDate": "A String", # The last date that this early vote site may be used. This field is not populated for polling locations.
- "name": "A String", # The name of the early vote site. This field is not populated for polling locations.
- "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use)
- "voterServices": "A String", # The services provided by this early vote site. This field is not populated for polling locations.
- "sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "address": { # A simple representation of an address. # The address of the location
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "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.
- },
- ],
- "contests": [ # Contests that will appear on the voter's ballot
- { # Information about a contest that appears on a voter's ballot.
- "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: 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.
- },
- "level": "A String", # The level of office for this contest. One of: federal, state, county, city, other
- "type": "A String", # The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'.
- "ballotPlacement": "A String", # A number specifying the position of this contest on the voter's ballot.
- "sources": [ # A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "referendumSubtitle": "A String", # A brief description of the referendum. This field is only populated for contests of type 'Referendum'.
- "primaryParty": "A String", # If this is a partisan election, the name of the party it is for.
- "candidates": [ # The candidate choices for this contest.
- { # Information about a candidate running for elected office.
- "name": "A String", # The candidate's name.
- "photoUrl": "A String", # A URL for a photo of the candidate.
- "candidateUrl": "A String", # The URL for the candidate's campaign web site.
- "channels": [ # A list of known (social) media channels for this candidate.
- { # A social media or web channel for a candidate.
- "type": "A String", # The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter
- "id": "A String", # The unique public identifier for the candidate's channel.
- },
- ],
- "phone": "A String", # The voice phone number for the candidate's campaign office.
- "orderOnBallot": "A String", # The order the candidate appears on the ballot for this contest.
- "party": "A String", # The full name of the party the candidate is a member of.
- "email": "A String", # The email address for the candidate's campaign.
- },
- ],
- "numberElected": "A String", # The number of candidates that will be elected to office in this contest.
- "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'.
- "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.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/civicinfo_us_v1.html b/docs/dyn/civicinfo_us_v1.html
deleted file mode 100644
index 35b6bfd..0000000
--- a/docs/dyn/civicinfo_us_v1.html
+++ /dev/null
@@ -1,92 +0,0 @@
-<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="civicinfo_us_v1.html">Google Civic Information API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="civicinfo_us_v1.divisions.html">divisions()</a></code>
-</p>
-<p class="firstline">Returns the divisions Resource.</p>
-
-<p class="toc_element">
- <code><a href="civicinfo_us_v1.elections.html">elections()</a></code>
-</p>
-<p class="firstline">Returns the elections Resource.</p>
-
-<p class="toc_element">
- <code><a href="civicinfo_us_v1.representatives.html">representatives()</a></code>
-</p>
-<p class="firstline">Returns the representatives Resource.</p>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/civicinfo_us_v1.representatives.html b/docs/dyn/civicinfo_us_v1.representatives.html
deleted file mode 100644
index 5f38796..0000000
--- a/docs/dyn/civicinfo_us_v1.representatives.html
+++ /dev/null
@@ -1,171 +0,0 @@
-<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="civicinfo_us_v1.html">Google Civic Information API</a> . <a href="civicinfo_us_v1.representatives.html">representatives</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#representativeInfoQuery">representativeInfoQuery(body, ocdId=None, includeOffices=None)</a></code></p>
-<p class="firstline">Looks up political geography and (optionally) representative information based on an address.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="representativeInfoQuery">representativeInfoQuery(body, ocdId=None, includeOffices=None)</code>
- <pre>Looks up political geography and (optionally) representative information based on an address.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A request for political geography and representative information for an address.
- "address": "A String", # The address to look up. May only be specified if the field ocdId is not given in the URL.
- }
-
- ocdId: string, The division to look up. May only be specified if the address field is not given in the request body.
- includeOffices: boolean, Whether to return information about offices and officials. If false, only the top-level district information will be returned.
-
-Returns:
- An object of the form:
-
- { # The result of a representative info lookup query.
- "status": "A String", # The result of the request. One of: success, noStreetSegmentFound, addressUnparseable, noAddressParameter, multipleStreetSegmentsFound, electionOver, electionUnknown, internalLookupFailure, RequestedBothAddressAndOcdId
- "divisions": { # Political geographic divisions that contain the requested address.
- "a_key": { # Describes a political geography. # The unique Open Civic Data identifier for this division.
- "scope": "A String", # The geographic scope of the division. If unspecified, the division's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special
- "name": "A String", # The name of the division.
- "officeIds": [ # List of keys in the offices object, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.
- "A String",
- ],
- },
- },
- "kind": "civicinfo#representativeInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse".
- "normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "officials": { # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
- "a_key": { # Information about a official holding an elected office. # A unique identifier for this official, within the context of this request. Identifiers are *not* long-lived: the same official may get different IDs on different requests.
- "name": "A String", # The official's name.
- "photoUrl": "A String", # A URL for a photo of the official.
- "phones": [ # The official's public contact phone numbers.
- "A String",
- ],
- "channels": [ # A list of known (social) media channels for this official.
- { # A social media or web channel for a candidate.
- "type": "A String", # The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter
- "id": "A String", # The unique public identifier for the candidate's channel.
- },
- ],
- "urls": [ # The official's public website URLs.
- "A String",
- ],
- "address": [ # Addresses at which to contact the official.
- { # A simple representation of an address.
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- ],
- "party": "A String", # The full name of the party the official belongs to.
- "emails": [ # The direct email addresses for the official.
- "A String",
- ],
- },
- },
- "offices": { # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
- "a_key": { # Information about an Office held by one or more Officials. # A unique identifier for this office, within the context of this request. Identifiers are *not* long-lived: the same office may get different IDs on different requests.
- "sources": [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "officialIds": [ # List of people who presently hold the office.
- "A String",
- ],
- "name": "A String", # The human-readable name of the office.
- "level": "A String", # The level of this elected office. One of: federal, state, county, city, other
- },
- },
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/civicinfo_v1.divisions.html b/docs/dyn/civicinfo_v1.divisions.html
deleted file mode 100644
index 4c0a424..0000000
--- a/docs/dyn/civicinfo_v1.divisions.html
+++ /dev/null
@@ -1,106 +0,0 @@
-<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="civicinfo_v1.html">Google Civic Information API</a> . <a href="civicinfo_v1.divisions.html">divisions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#search">search(query=None)</a></code></p>
-<p class="firstline">Searches for political divisions by their natural name or OCD ID.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="search">search(query=None)</code>
- <pre>Searches for political divisions by their natural name or OCD ID.
-
-Args:
- query: string, The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html
-
-Returns:
- An object of the form:
-
- { # The result of a division search query.
- "status": "A String", # The result of the request. One of: success, addressUnparseable, noAddressParameter, internalLookupFailure
- "kind": "civicinfo#divisionSearchResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#divisionSearchResponse".
- "results": [
- { # Represents a political geographic division that matches the requested query.
- "ocdId": "A String", # The unique Open Civic Data identifier for this division.
- "name": "A String", # The name of the division.
- "aliases": [ # Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district.
- "A String",
- ],
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/civicinfo_v1.elections.html b/docs/dyn/civicinfo_v1.elections.html
deleted file mode 100644
index c24d6ef..0000000
--- a/docs/dyn/civicinfo_v1.elections.html
+++ /dev/null
@@ -1,294 +0,0 @@
-<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="civicinfo_v1.html">Google Civic Information API</a> . <a href="civicinfo_v1.elections.html">elections</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#electionQuery">electionQuery()</a></code></p>
-<p class="firstline">List of available elections to query.</p>
-<p class="toc_element">
- <code><a href="#voterInfoQuery">voterInfoQuery(electionId, body, officialOnly=None)</a></code></p>
-<p class="firstline">Looks up information relevant to a voter based on the voter's registered address.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="electionQuery">electionQuery()</code>
- <pre>List of available elections to query.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # The list of elections available for this version of the API.
- "kind": "civicinfo#electionsQueryResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse".
- "elections": [ # A list of available elections
- { # Information about the election that was queried.
- "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
- "id": "A String", # The unique ID of this election.
- "name": "A String", # A displayable name for the election.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="voterInfoQuery">voterInfoQuery(electionId, body, officialOnly=None)</code>
- <pre>Looks up information relevant to a voter based on the voter's registered address.
-
-Args:
- electionId: string, The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/elections (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A request for information about a voter.
- "address": "A String", # The registered address of the voter to look up.
- }
-
- officialOnly: boolean, If set to true, only data from official state sources will be returned.
-
-Returns:
- An object of the form:
-
- { # The result of a voter info lookup query.
- "status": "A String", # The result of the request. One of: success, noStreetSegmentFound, addressUnparseable, noAddressParameter, multipleStreetSegmentsFound, electionOver, electionUnknown, internalLookupFailure
- "earlyVoteSites": [ # Locations where the voter is eligible to vote early, prior to election day
- { # A location where a voter can vote. This may be an early vote site or an election day voting location.
- "startDate": "A String", # The first date that this early vote site may be used. This field is not populated for polling locations.
- "pollingHours": "A String", # A description of when this location is open.
- "endDate": "A String", # The last date that this early vote site may be used. This field is not populated for polling locations.
- "name": "A String", # The name of the early vote site. This field is not populated for polling locations.
- "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use)
- "voterServices": "A String", # The services provided by this early vote site. This field is not populated for polling locations.
- "sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "address": { # A simple representation of an address. # The address of the location
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "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.
- },
- ],
- "kind": "civicinfo#voterInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse".
- "normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "state": [ # Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.
- { # Describes information about a regional election administrative area.
- "local_jurisdiction": # Object with schema name: AdministrationRegion # The city or county that provides election information for this voter. This object can have the same elements as state.
- "sources": [ # A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "electionAdministrationBody": { # Information about an election administrative body (e.g. County Board of Elections). # The election administration body for this area.
- "absenteeVotingInfoUrl": "A String", # A URL provided by this administrative body for information on absentee voting.
- "votingLocationFinderUrl": "A String", # A URL provided by this administrative body for looking up where to vote.
- "name": "A String", # The name of this election administrative body.
- "electionRegistrationConfirmationUrl": "A String", # A URL provided by this administrative body for confirming that the voter is registered to vote.
- "correspondenceAddress": { # A simple representation of an address. # The mailing address of this administrative body.
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "electionRegistrationUrl": "A String", # A URL provided by this administrative body for looking up how to register to vote.
- "electionOfficials": [ # The election officials for this election administrative body.
- { # Information about individual election officials.
- "title": "A String", # The title of the election official.
- "emailAddress": "A String", # The email address of the election official.
- "name": "A String", # The full name of the election official.
- "officePhoneNumber": "A String", # The office phone number of the election official.
- "faxNumber": "A String", # The fax number of the election official.
- },
- ],
- "electionInfoUrl": "A String", # A URL provided by this administrative body for looking up general election information.
- "electionRulesUrl": "A String", # A URL provided by this administrative body describing election rules to the voter.
- "voter_services": [ # A description of the services this administrative body may provide.
- "A String",
- ],
- "ballotInfoUrl": "A String", # A URL provided by this administrative body to give contest information to the voter.
- "hoursOfOperation": "A String", # A description of the hours of operation for this administrative body.
- "physicalAddress": { # A simple representation of an address. # The physical address of this administrative body.
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- },
- "name": "A String", # The name of the jurisdiction.
- "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.
- },
- ],
- "election": { # Information about the election that was queried. # The election that was queried.
- "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
- "id": "A String", # The unique ID of this election.
- "name": "A String", # A displayable name for the election.
- },
- "pollingLocations": [ # Locations where the voter is eligible to vote on election day. For states with mail-in voting only, these locations will be nearby drop box locations. Drop box locations are free to the voter and may be used instead of placing the ballot in the mail.
- { # A location where a voter can vote. This may be an early vote site or an election day voting location.
- "startDate": "A String", # The first date that this early vote site may be used. This field is not populated for polling locations.
- "pollingHours": "A String", # A description of when this location is open.
- "endDate": "A String", # The last date that this early vote site may be used. This field is not populated for polling locations.
- "name": "A String", # The name of the early vote site. This field is not populated for polling locations.
- "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use)
- "voterServices": "A String", # The services provided by this early vote site. This field is not populated for polling locations.
- "sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "address": { # A simple representation of an address. # The address of the location
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "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.
- },
- ],
- "contests": [ # Contests that will appear on the voter's ballot
- { # Information about a contest that appears on a voter's ballot.
- "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: 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.
- },
- "level": "A String", # The level of office for this contest. One of: federal, state, county, city, other
- "type": "A String", # The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'.
- "ballotPlacement": "A String", # A number specifying the position of this contest on the voter's ballot.
- "sources": [ # A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "referendumSubtitle": "A String", # A brief description of the referendum. This field is only populated for contests of type 'Referendum'.
- "primaryParty": "A String", # If this is a partisan election, the name of the party it is for.
- "candidates": [ # The candidate choices for this contest.
- { # Information about a candidate running for elected office.
- "name": "A String", # The candidate's name.
- "photoUrl": "A String", # A URL for a photo of the candidate.
- "candidateUrl": "A String", # The URL for the candidate's campaign web site.
- "channels": [ # A list of known (social) media channels for this candidate.
- { # A social media or web channel for a candidate.
- "type": "A String", # The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter
- "id": "A String", # The unique public identifier for the candidate's channel.
- },
- ],
- "phone": "A String", # The voice phone number for the candidate's campaign office.
- "orderOnBallot": "A String", # The order the candidate appears on the ballot for this contest.
- "party": "A String", # The full name of the party the candidate is a member of.
- "email": "A String", # The email address for the candidate's campaign.
- },
- ],
- "numberElected": "A String", # The number of candidates that will be elected to office in this contest.
- "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'.
- "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.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/civicinfo_v1.html b/docs/dyn/civicinfo_v1.html
deleted file mode 100644
index 4476d0e..0000000
--- a/docs/dyn/civicinfo_v1.html
+++ /dev/null
@@ -1,92 +0,0 @@
-<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="civicinfo_v1.html">Google Civic Information API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="civicinfo_v1.divisions.html">divisions()</a></code>
-</p>
-<p class="firstline">Returns the divisions Resource.</p>
-
-<p class="toc_element">
- <code><a href="civicinfo_v1.elections.html">elections()</a></code>
-</p>
-<p class="firstline">Returns the elections Resource.</p>
-
-<p class="toc_element">
- <code><a href="civicinfo_v1.representatives.html">representatives()</a></code>
-</p>
-<p class="firstline">Returns the representatives Resource.</p>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/civicinfo_v1.representatives.html b/docs/dyn/civicinfo_v1.representatives.html
deleted file mode 100644
index 0bd478e..0000000
--- a/docs/dyn/civicinfo_v1.representatives.html
+++ /dev/null
@@ -1,176 +0,0 @@
-<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="civicinfo_v1.html">Google Civic Information API</a> . <a href="civicinfo_v1.representatives.html">representatives</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#representativeInfoQuery">representativeInfoQuery(body, recursive=None, ocdId=None, includeOffices=None)</a></code></p>
-<p class="firstline">Looks up political geography and representative information based on an address or Open Civic Data division identifier.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="representativeInfoQuery">representativeInfoQuery(body, recursive=None, ocdId=None, includeOffices=None)</code>
- <pre>Looks up political geography and representative information based on an address or Open Civic Data division identifier.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A request for political geography and representative information for an address.
- "address": "A String", # The address to look up. May only be specified if the field ocdId is not given in the URL.
- }
-
- recursive: boolean, When ocd_id is supplied, return all divisions which are hierarchically nested within the queried division. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.
- ocdId: string, The division to look up. May only be specified if the address field is not given in the request body.
- includeOffices: boolean, Whether to return information about offices and officials. If false, only the top-level district information will be returned.
-
-Returns:
- An object of the form:
-
- { # The result of a representative info lookup query.
- "status": "A String", # The result of the request. One of: success, noStreetSegmentFound, addressUnparseable, noAddressParameter, multipleStreetSegmentsFound, electionOver, electionUnknown, internalLookupFailure, RequestedBothAddressAndOcdId
- "divisions": { # Political geographic divisions that contain the requested address.
- "a_key": { # Describes a political geography. # The unique Open Civic Data identifier for this division.
- "scope": "A String", # The geographic scope of the division. If unspecified, the division's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special
- "officeIds": [ # List of keys in the offices object, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.
- "A String",
- ],
- "alsoKnownAs": [ # Any other valid OCD IDs that refer to the same division. For example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
- "A String",
- ],
- "name": "A String", # The name of the division.
- },
- },
- "kind": "civicinfo#representativeInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse".
- "normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "officials": { # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
- "a_key": { # Information about a official holding an elected office. # A unique identifier for this official, within the context of this request. Identifiers are *not* long-lived: the same official may get different IDs on different requests.
- "name": "A String", # The official's name.
- "photoUrl": "A String", # A URL for a photo of the official.
- "phones": [ # The official's public contact phone numbers.
- "A String",
- ],
- "channels": [ # A list of known (social) media channels for this official.
- { # A social media or web channel for a candidate.
- "type": "A String", # The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter
- "id": "A String", # The unique public identifier for the candidate's channel.
- },
- ],
- "urls": [ # The official's public website URLs.
- "A String",
- ],
- "address": [ # Addresses at which to contact the official.
- { # A simple representation of an address.
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- ],
- "party": "A String", # The full name of the party the official belongs to.
- "emails": [ # The direct email addresses for the official.
- "A String",
- ],
- },
- },
- "offices": { # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
- "a_key": { # Information about an Office held by one or more Officials. # A unique identifier for this office, within the context of this request. Identifiers are *not* long-lived: the same office may get different IDs on different requests.
- "divisionId": "A String", # The OCD ID of the division with which this office is associated.
- "sources": [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "officialIds": [ # List of keys in the officials object of people who presently hold this office.
- "A String",
- ],
- "name": "A String", # The human-readable name of the office.
- "level": "A String", # The level of this elected office. One of: federal, state, county, city, other
- },
- },
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/civicinfo_v2.elections.html b/docs/dyn/civicinfo_v2.elections.html
index 317cf78..224a01c 100644
--- a/docs/dyn/civicinfo_v2.elections.html
+++ b/docs/dyn/civicinfo_v2.elections.html
@@ -306,7 +306,7 @@
"referendumProStatement": "A String", # A statement in favor of the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'.
"candidates": [ # The candidate choices for this contest.
{ # Information about a candidate running for elected office.
- "name": "A String", # The candidate's name.
+ "name": "A String", # The candidate's name. If this is a joint ticket it will indicate the name of the candidate at the top of a ticket followed by a / and that name of candidate at the bottom of the ticket. e.g. "Mitt Romney / Paul Ryan"
"photoUrl": "A String", # A URL for a photo of the candidate.
"candidateUrl": "A String", # The URL for the candidate's campaign web site.
"channels": [ # A list of known (social) media channels for this candidate.
diff --git a/docs/dyn/cloudlatencytest_v2.html b/docs/dyn/cloudlatencytest_v2.html
deleted file mode 100644
index 486631c..0000000
--- a/docs/dyn/cloudlatencytest_v2.html
+++ /dev/null
@@ -1,103 +0,0 @@
-<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="cloudlatencytest_v2.html">Google Cloud Network Performance Monitoring API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="cloudlatencytest_v2.statscollection.html">statscollection()</a></code>
-</p>
-<p class="firstline">Returns the statscollection Resource.</p>
-
-<p class="toc_element">
- <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
-<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
- <pre>Create a BatchHttpRequest object based on the discovery document.
-
- Args:
- callback: callable, A callback to be called for each response, of the
- form callback(id, response, exception). The first parameter is the
- request id, and the second is the deserialized response object. The
- third is an apiclient.errors.HttpError exception object if an HTTP
- error occurred while processing the request, or None if no error
- occurred.
-
- Returns:
- A BatchHttpRequest object based on the discovery document.
- </pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/cloudlatencytest_v2.statscollection.html b/docs/dyn/cloudlatencytest_v2.statscollection.html
deleted file mode 100644
index ee9c717..0000000
--- a/docs/dyn/cloudlatencytest_v2.statscollection.html
+++ /dev/null
@@ -1,166 +0,0 @@
-<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="cloudlatencytest_v2.html">Google Cloud Network Performance Monitoring API</a> . <a href="cloudlatencytest_v2.statscollection.html">statscollection</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#updateaggregatedstats">updateaggregatedstats(body)</a></code></p>
-<p class="firstline">RPC to update the new TCP stats.</p>
-<p class="toc_element">
- <code><a href="#updatestats">updatestats(body)</a></code></p>
-<p class="firstline">RPC to update the new TCP stats.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="updateaggregatedstats">updateaggregatedstats(body)</code>
- <pre>RPC to update the new TCP stats.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "stats": [
- {
- "stringValues": [
- {
- "value": "A String",
- "label": "A String",
- },
- ],
- "intValues": [
- {
- "value": "A String",
- "label": "A String",
- },
- ],
- "doubleValues": [
- {
- "value": 3.14,
- "label": "A String",
- },
- ],
- "time": 3.14,
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "testValue": "A String",
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="updatestats">updatestats(body)</code>
- <pre>RPC to update the new TCP stats.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "stringValues": [
- {
- "value": "A String",
- "label": "A String",
- },
- ],
- "intValues": [
- {
- "value": "A String",
- "label": "A String",
- },
- ],
- "doubleValues": [
- {
- "value": 3.14,
- "label": "A String",
- },
- ],
- "time": 3.14,
- }
-
-
-Returns:
- An object of the form:
-
- {
- "testValue": "A String",
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/cloudmonitoring_v2beta1.html b/docs/dyn/cloudmonitoring_v2beta1.html
deleted file mode 100644
index b0b0520..0000000
--- a/docs/dyn/cloudmonitoring_v2beta1.html
+++ /dev/null
@@ -1,92 +0,0 @@
-<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="cloudmonitoring_v2beta1.html">Cloud Monitoring API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="cloudmonitoring_v2beta1.metricDescriptors.html">metricDescriptors()</a></code>
-</p>
-<p class="firstline">Returns the metricDescriptors Resource.</p>
-
-<p class="toc_element">
- <code><a href="cloudmonitoring_v2beta1.timeseries.html">timeseries()</a></code>
-</p>
-<p class="firstline">Returns the timeseries Resource.</p>
-
-<p class="toc_element">
- <code><a href="cloudmonitoring_v2beta1.timeseriesDescriptors.html">timeseriesDescriptors()</a></code>
-</p>
-<p class="firstline">Returns the timeseriesDescriptors Resource.</p>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/cloudmonitoring_v2beta1.metricDescriptors.html b/docs/dyn/cloudmonitoring_v2beta1.metricDescriptors.html
deleted file mode 100644
index 04fc5df..0000000
--- a/docs/dyn/cloudmonitoring_v2beta1.metricDescriptors.html
+++ /dev/null
@@ -1,134 +0,0 @@
-<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="cloudmonitoring_v2beta1.html">Cloud Monitoring API</a> . <a href="cloudmonitoring_v2beta1.metricDescriptors.html">metricDescriptors</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(project, count=None, pageToken=None, query=None)</a></code></p>
-<p class="firstline">List metric descriptors that match the query. If the query is not set, then all of the metric descriptors will be returned. Large responses will be paginated, use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.</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(project, count=None, pageToken=None, query=None)</code>
- <pre>List metric descriptors that match the query. If the query is not set, then all of the metric descriptors will be returned. Large responses will be paginated, use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.
-
-Args:
- project: string, The project id. The value can be the numeric project ID or string-based project name. (required)
- count: integer, Maximum number of metric descriptors per page. Used for pagination. If not specified, count = 100.
- pageToken: string, The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.
- query: string, The query used to search against existing metrics. Separate keywords with a space; the service joins all keywords with AND, meaning that all keywords must match for a metric to be returned. If this field is omitted, all metrics are returned. If an empty string is passed with this field, no metrics are returned.
-
-Returns:
- An object of the form:
-
- { # The response of cloudmonitoring.metricDescriptors.list.
- "metrics": [ # The returned metric descriptors.
- { # A metricDescriptor defines the name, label keys, and data type of a particular metric.
- "project": "A String", # The project ID to which the metric belongs.
- "labels": [ # Labels defined for this metric.
- { # A label in a metric is a description of this metric, including the key of this description (what the description is), and the value for this description.
- "description": "A String", # Label description.
- "key": "A String", # Label key.
- },
- ],
- "typeDescriptor": { # A type in a metric contains information about how the metric is collected and what its data points look like. # Type description for this metric.
- "valueType": "A String", # The type of data that is written to a timeseries point for this metric.
- "metricType": "A String", # The method of collecting data for the metric.
- },
- "description": "A String", # Description of this metric.
- "name": "A String", # The name of this metric.
- },
- ],
- "nextPageToken": "A String", # Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, pass this value to the pageToken query parameter.
- "kind": "cloudmonitoring#listMetricDescriptorsResponse", # Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listMetricDescriptorsResponse".
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/cloudmonitoring_v2beta1.timeseries.html b/docs/dyn/cloudmonitoring_v2beta1.timeseries.html
deleted file mode 100644
index 58c7176..0000000
--- a/docs/dyn/cloudmonitoring_v2beta1.timeseries.html
+++ /dev/null
@@ -1,173 +0,0 @@
-<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="cloudmonitoring_v2beta1.html">Cloud Monitoring API</a> . <a href="cloudmonitoring_v2beta1.timeseries.html">timeseries</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(project, metric, youngest, count=None, timespan=None, labels=None, pageToken=None, oldest=None)</a></code></p>
-<p class="firstline">List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.</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(project, metric, youngest, count=None, timespan=None, labels=None, pageToken=None, oldest=None)</code>
- <pre>List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.
-
-Args:
- project: string, The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name. (required)
- metric: string, Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count. (required)
- youngest: string, End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp. (required)
- count: integer, Maximum number of data points per page, which is used for pagination of results.
- timespan: string, Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units:
-- s: second
-- m: minute
-- h: hour
-- d: day
-- w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.
-
-If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest].
- labels: string, A collection of labels for the matching time series, which are represented as:
-- key==value: key equals the value
-- key=~value: key regex matches the value
-- key!=value: key does not equal the value
-- key!~value: key regex does not match the value For example, to list all of the time series descriptors for the region us-central1, you could specify:
-label=cloud.googleapis.com%2Flocation=~us-central1.* (repeated)
- pageToken: string, The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.
- oldest: string, Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]
-
-Returns:
- An object of the form:
-
- { # The response of cloudmonitoring.timeseries.list
- "nextPageToken": "A String", # Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, set the pageToken query parameter to this value. All of the points of a time series will be returned before returning any point of the subsequent time series.
- "youngest": "A String", # The youngest timestamp of the interval of this query as an RFC 3339 string.
- "kind": "cloudmonitoring#listTimeseriesResponse", # Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listTimeseriesResponse".
- "oldest": "A String", # The oldest timestamp of the interval of this query as an RFC 3339 string.
- "timeseries": [ # The returned time series.
- { # The monitoring data is organized as metrics and stored as data points that are recorded over time. Each data point represents information like the CPU utilization of your virtual machine. A historical record of these data points is called a time series.
- "timeseriesDesc": { # TimeseriesDescriptor identifies a single time series. # The descriptor of this time series.
- "project": "A String", # The Developers Console project number to which this time series belongs.
- "metric": "A String", # The name of the metric.
- "labels": { # The label's name.
- "a_key": "A String", # The label's name.
- },
- },
- "points": [ # The data points of this time series. The points are listed in order of their end timestamp, from younger to older.
- { # Point is a single point in a time series. It consists of a start time, an end time, and a value.
- "end": "A String", # The interval [start, end] is the time period to which the point's value applies. For gauge metrics, whose values are instantaneous measurements, this interval should be empty (start should equal end). For cumulative metrics (of which deltas and rates are special cases), the interval should be non-empty. Both start and end are RFC 3339 strings.
- "doubleValue": 3.14, # The value of this data point as a double-precision floating-point number.
- "start": "A String", # The interval [start, end] is the time period to which the point's value applies. For gauge metrics, whose values are instantaneous measurements, this interval should be empty (start should equal end). For cumulative metrics (of which deltas and rates are special cases), the interval should be non-empty. Both start and end are RFC 3339 strings.
- "boolValue": True or False, # The value of this data point. Either "true" or "false".
- "distributionValue": { # Distribution data point value type. When writing distribution points, try to be consistent with the boundaries of your buckets. If you must modify the bucket boundaries, then do so by merging, partitioning, or appending rather than skewing them. # The value of this data point as a distribution. A distribution value can contain a list of buckets and/or an underflowBucket and an overflowBucket. The values of these points can be used to create a histogram.
- "buckets": [ # The finite buckets.
- { # The histogram's bucket. Buckets that form the histogram of a distribution value. If the upper bound of a bucket, say U1, does not equal the lower bound of the next bucket, say L2, this means that there is no event in [U1, L2).
- "count": "A String", # The number of events whose values are in the interval defined by this bucket.
- "lowerBound": 3.14, # The lower bound of the value interval of this bucket (inclusive).
- "upperBound": 3.14, # The upper bound of the value interval of this bucket (exclusive).
- },
- ],
- "underflowBucket": { # The underflow bucket is a special bucket that does not have the lowerBound field; it includes all of the events that are less than its upper bound. # The underflow bucket.
- "count": "A String", # The number of events whose values are in the interval defined by this bucket.
- "upperBound": 3.14, # The upper bound of the value interval of this bucket (exclusive).
- },
- "overflowBucket": { # The overflow bucket is a special bucket that does not have the upperBound field; it includes all of the events that are no less than its lower bound. # The overflow bucket.
- "count": "A String", # The number of events whose values are in the interval defined by this bucket.
- "lowerBound": 3.14, # The lower bound of the value interval of this bucket (inclusive).
- },
- },
- "stringValue": "A String", # The value of this data point in string format.
- "int64Value": "A String", # The value of this data point as a 64-bit integer.
- },
- ],
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/cloudmonitoring_v2beta1.timeseriesDescriptors.html b/docs/dyn/cloudmonitoring_v2beta1.timeseriesDescriptors.html
deleted file mode 100644
index dec725a..0000000
--- a/docs/dyn/cloudmonitoring_v2beta1.timeseriesDescriptors.html
+++ /dev/null
@@ -1,144 +0,0 @@
-<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="cloudmonitoring_v2beta1.html">Cloud Monitoring API</a> . <a href="cloudmonitoring_v2beta1.timeseriesDescriptors.html">timeseriesDescriptors</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(project, metric, youngest, count=None, timespan=None, labels=None, pageToken=None, oldest=None)</a></code></p>
-<p class="firstline">List the descriptors of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.</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(project, metric, youngest, count=None, timespan=None, labels=None, pageToken=None, oldest=None)</code>
- <pre>List the descriptors of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.
-
-Args:
- project: string, The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name. (required)
- metric: string, Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count. (required)
- youngest: string, End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp. (required)
- count: integer, Maximum number of time series descriptors per page. Used for pagination. If not specified, count = 100.
- timespan: string, Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units:
-- s: second
-- m: minute
-- h: hour
-- d: day
-- w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.
-
-If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest].
- labels: string, A collection of labels for the matching time series, which are represented as:
-- key==value: key equals the value
-- key=~value: key regex matches the value
-- key!=value: key does not equal the value
-- key!~value: key regex does not match the value For example, to list all of the time series descriptors for the region us-central1, you could specify:
-label=cloud.googleapis.com%2Flocation=~us-central1.* (repeated)
- pageToken: string, The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.
- oldest: string, Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]
-
-Returns:
- An object of the form:
-
- { # The response of cloudmonitoring.timeseriesDescriptors.list
- "nextPageToken": "A String", # Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, set this value to the pageToken query parameter.
- "youngest": "A String", # The youngest timestamp of the interval of this query, as an RFC 3339 string.
- "kind": "cloudmonitoring#listTimeseriesDescriptorsResponse", # Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listTimeseriesDescriptorsResponse".
- "oldest": "A String", # The oldest timestamp of the interval of this query, as an RFC 3339 string.
- "timeseries": [ # The returned time series descriptors.
- { # TimeseriesDescriptor identifies a single time series.
- "project": "A String", # The Developers Console project number to which this time series belongs.
- "metric": "A String", # The name of the metric.
- "labels": { # The label's name.
- "a_key": "A String", # The label's name.
- },
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/cloudresourcemanager_v1beta1.organizations.html b/docs/dyn/cloudresourcemanager_v1beta1.organizations.html
index 86681d7..5ba6cdc 100644
--- a/docs/dyn/cloudresourcemanager_v1beta1.organizations.html
+++ b/docs/dyn/cloudresourcemanager_v1beta1.organizations.html
@@ -75,11 +75,11 @@
<h1><a href="cloudresourcemanager_v1beta1.html">Google Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1beta1.organizations.html">organizations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#get">get(organizationId, x__xgafv=None)</a></code></p>
-<p class="firstline">Fetches an Organization resource identified by the specified `organization_id`.</p>
+ <code><a href="#get">get(name, organizationId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Fetches an Organization resource identified by the specified resource name.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists.</p>
+<p class="firstline">Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. "organizations/123".</p>
<p class="toc_element">
<code><a href="#list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the list.</p>
@@ -88,41 +88,44 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Sets the access control policy on an Organization resource. Replaces any existing policy.</p>
+<p class="firstline">Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. "organizations/123".</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns permissions that a caller has on the specified Organization.</p>
+<p class="firstline">Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. "organizations/123".</p>
<p class="toc_element">
- <code><a href="#update">update(organizationId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates an Organization resource identified by the specified `organization_id`.</p>
+ <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates an Organization resource identified by the specified resource name.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="get">get(organizationId, x__xgafv=None)</code>
- <pre>Fetches an Organization resource identified by the specified `organization_id`.
+ <code class="details" id="get">get(name, organizationId=None, x__xgafv=None)</code>
+ <pre>Fetches an Organization resource identified by the specified resource name.
Args:
- organizationId: string, The id of the Organization resource to fetch. (required)
+ name: string, The resource name of the Organization to fetch, e.g. "organizations/1234". (required)
+ organizationId: string, The id of the Organization resource to fetch. This field is deprecated and will be removed in v1. Use name instead.
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
- "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only.
+ "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. @OutputOnly
+ "name": "A String", # Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
+ "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. This field is deprecated and will be removed in v1. Use name instead.
+ "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
+ "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. @OutputOnly
"owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
"directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
},
- "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. This field is required.
- "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</code>
- <pre>Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists.
+ <pre>Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. "organizations/123".
Args:
- resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `getIamPolicy` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -134,7 +137,7 @@
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
"bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
@@ -165,12 +168,14 @@
"nextPageToken": "A String", # A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results.
"organizations": [ # The list of Organizations that matched the list query, possibly paginated.
{ # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
- "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only.
+ "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. @OutputOnly
+ "name": "A String", # Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
+ "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. This field is deprecated and will be removed in v1. Use name instead.
+ "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
+ "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. @OutputOnly
"owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
"directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
},
- "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. This field is required.
- "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
},
],
}</pre>
@@ -192,15 +197,15 @@
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
- <pre>Sets the access control policy on an Organization resource. Replaces any existing policy.
+ <pre>Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. "organizations/123".
Args:
- resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `setIamPolicy` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
+ "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
"bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
@@ -219,7 +224,7 @@
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
"bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
@@ -235,15 +240,15 @@
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
- <pre>Returns permissions that a caller has on the specified Organization.
+ <pre>Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. "organizations/123".
Args:
- resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `testIamPermissions` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
@@ -261,21 +266,23 @@
</div>
<div class="method">
- <code class="details" id="update">update(organizationId, body, x__xgafv=None)</code>
- <pre>Updates an Organization resource identified by the specified `organization_id`.
+ <code class="details" id="update">update(name, body, x__xgafv=None)</code>
+ <pre>Updates an Organization resource identified by the specified resource name.
Args:
- organizationId: string, An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. (required)
+ name: string, Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234". (required)
body: object, The request body. (required)
The object takes the form of:
{ # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
- "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only.
+ "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. @OutputOnly
+ "name": "A String", # Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
+ "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. This field is deprecated and will be removed in v1. Use name instead.
+ "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
+ "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. @OutputOnly
"owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
"directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
},
- "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. This field is required.
- "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
}
x__xgafv: string, V1 error format.
@@ -284,12 +291,14 @@
An object of the form:
{ # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
- "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only.
+ "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. Assigned by the server, set to the firm name of the Google For Work customer that owns this organization. @OutputOnly
+ "name": "A String", # Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
+ "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. This field is deprecated and will be removed in v1. Use name instead.
+ "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
+ "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. @OutputOnly
"owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
"directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
},
- "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. This field is required.
- "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
}</pre>
</div>
diff --git a/docs/dyn/cloudresourcemanager_v1beta1.projects.html b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
index 2cfa8ea..1c5be48 100644
--- a/docs/dyn/cloudresourcemanager_v1beta1.projects.html
+++ b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
@@ -75,15 +75,18 @@
<h1><a href="cloudresourcemanager_v1beta1.html">Google Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1beta1.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(body, useLegacyStack=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Project resource. Initially, the Project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the Project. Several APIs are activated automatically for the Project, including Google Cloud Storage.</p>
<p class="toc_element">
<code><a href="#delete">delete(projectId, x__xgafv=None)</a></code></p>
-<p class="firstline">Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the lifecycle state changes to DELETE_IN_PROGRESS. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.</p>
+<p class="firstline">Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.</p>
<p class="toc_element">
<code><a href="#get">get(projectId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.</p>
<p class="toc_element">
+ <code><a href="#getAncestry">getAncestry(projectId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a list of ancestors in the resource hierarchy for the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.</p>
+<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.</p>
<p class="toc_element">
@@ -94,19 +97,19 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project currently supports only `user:{emailid}` and `serviceAccount:{emailid}` members in a `Binding` of a `Policy`. + To be added as an `owner`, a user must be invited via Cloud Platform console and must accept the invitation. + Members cannot be added to more than one role in the same policy. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.</p>
+<p class="firstline">Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted only to `user` and `serviceAccount`. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified Project.</p>
<p class="toc_element">
- <code><a href="#undelete">undelete(projectId, x__xgafv=None)</a></code></p>
-<p class="firstline">Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, as indicated by a lifecycle state of DELETE_IN_PROGRESS, the Project cannot be restored. The caller must have modify permissions for this Project.</p>
+ <code><a href="#undelete">undelete(projectId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot be restored. The caller must have modify permissions for this Project.</p>
<p class="toc_element">
<code><a href="#update">update(projectId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(body, x__xgafv=None)</code>
+ <code class="details" id="create">create(body, useLegacyStack=None, x__xgafv=None)</code>
<pre>Creates a Project resource. Initially, the Project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the Project. Several APIs are activated automatically for the Project, including Google Cloud Storage.
Args:
@@ -114,9 +117,9 @@
The object takes the form of:
{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
- "name": "A String", # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
+ "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
"parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
- "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
+ "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
"id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
},
"projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
@@ -128,15 +131,16 @@
"createTime": "A String", # Creation time. Read-only.
}
+ useLegacyStack: boolean, A safety hatch to opt out of the new reliable project creation process.
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
- "name": "A String", # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
+ "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
"parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
- "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
+ "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
"id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
},
"projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
@@ -151,7 +155,7 @@
<div class="method">
<code class="details" id="delete">delete(projectId, x__xgafv=None)</code>
- <pre>Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the lifecycle state changes to DELETE_IN_PROGRESS. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.
+ <pre>Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.
Args:
projectId: string, The Project ID (for example, `foo-bar-123`). Required. (required)
@@ -176,9 +180,9 @@
An object of the form:
{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
- "name": "A String", # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
+ "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
"parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
- "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
+ "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
"id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
},
"projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
@@ -192,11 +196,40 @@
</div>
<div class="method">
+ <code class="details" id="getAncestry">getAncestry(projectId, body, x__xgafv=None)</code>
+ <pre>Gets a list of ancestors in the resource hierarchy for the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.
+
+Args:
+ projectId: string, The Project ID (for example, `my-project-123`). Required. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetAncestry method.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Response from the GetAncestry method.
+ "ancestor": [ # Ancestors are ordered from bottom to top of the resource hierarchy. The first ancestor is the project itself, followed by the project's parent, etc.
+ { # Identifying information for a single ancestor of a project.
+ "resourceId": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # Resource id of the ancestor.
+ "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
+ },
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</code>
<pre>Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.
Args:
- resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `getIamPolicy` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -208,7 +241,7 @@
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
"bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
@@ -239,9 +272,9 @@
"nextPageToken": "A String", # Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.
"projects": [ # The list of Projects that matched the list filter. This list can be paginated.
{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
- "name": "A String", # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
+ "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
"parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
- "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
+ "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
"id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
},
"projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
@@ -272,15 +305,15 @@
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
- <pre>Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project currently supports only `user:{emailid}` and `serviceAccount:{emailid}` members in a `Binding` of a `Policy`. + To be added as an `owner`, a user must be invited via Cloud Platform console and must accept the invitation. + Members cannot be added to more than one role in the same policy. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.
+ <pre>Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted only to `user` and `serviceAccount`. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.
Args:
- resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `setIamPolicy` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
+ "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
"bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
@@ -299,7 +332,7 @@
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
"bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
@@ -318,12 +351,12 @@
<pre>Returns permissions that a caller has on the specified Project.
Args:
- resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `testIamPermissions` documentation. (required)
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
@@ -341,11 +374,17 @@
</div>
<div class="method">
- <code class="details" id="undelete">undelete(projectId, x__xgafv=None)</code>
- <pre>Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, as indicated by a lifecycle state of DELETE_IN_PROGRESS, the Project cannot be restored. The caller must have modify permissions for this Project.
+ <code class="details" id="undelete">undelete(projectId, body, x__xgafv=None)</code>
+ <pre>Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot be restored. The caller must have modify permissions for this Project.
Args:
projectId: string, The project ID (for example, `foo-bar-123`). Required. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the UndeleteProject method.
+ }
+
x__xgafv: string, V1 error format.
Returns:
@@ -365,9 +404,9 @@
The object takes the form of:
{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
- "name": "A String", # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
+ "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
"parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
- "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
+ "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
"id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
},
"projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
@@ -385,9 +424,9 @@
An object of the form:
{ # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
- "name": "A String", # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
+ "name": "A String", # The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
"parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
- "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
+ "type": "A String", # Required field representing the resource type this id is for. At present, the valid types are "project" and "organization".
"id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
},
"projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
diff --git a/docs/dyn/serviceregistry_alpha.operations.html b/docs/dyn/clouduseraccounts_alpha.globalAccountsOperations.html
similarity index 83%
copy from docs/dyn/serviceregistry_alpha.operations.html
copy to docs/dyn/clouduseraccounts_alpha.globalAccountsOperations.html
index eec2283..0d0baf1 100644
--- a/docs/dyn/serviceregistry_alpha.operations.html
+++ b/docs/dyn/clouduseraccounts_alpha.globalAccountsOperations.html
@@ -72,25 +72,38 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.operations.html">operations</a></h1>
+<h1><a href="clouduseraccounts_alpha.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_alpha.globalAccountsOperations.html">globalAccountsOperations</a></h1>
<h2>Instance Methods</h2>
<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">Gets information about a specific operation.</p>
+<p class="firstline">Retrieves the specified operation resource.</p>
<p class="toc_element">
<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists all operations for a project.</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="get">get(project, operation)</code>
- <pre>Gets information about a specific operation.
+ <code class="details" id="delete">delete(project, operation)</code>
+ <pre>Deletes the specified operation resource.
Args:
- project: string, The project ID for this request. (required)
- operation: string, The name of the operation for this request. (required)
+ project: string, Project ID for this request. (required)
+ operation: string, Name of the Operations 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, Project ID for this request. (required)
+ operation: string, Name of the Operations resource to return. (required)
Returns:
An object of the form:
@@ -124,7 +137,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -144,10 +157,10 @@
<div class="method">
<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all operations for a project.
+ <pre>Retrieves the list of operation resources contained within the specified project.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -161,16 +174,16 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "operations": [ # [Output Only] Operations contained in this list response.
+ { # Contains a list of Operation resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Operation resources.
{ # An Operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] Reserved for future use.
@@ -200,7 +213,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -217,6 +230,9 @@
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
},
],
+ "kind": "clouduseraccounts#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/clouduseraccounts_alpha.groups.html b/docs/dyn/clouduseraccounts_alpha.groups.html
new file mode 100644
index 0000000..3dfe3c8
--- /dev/null
+++ b/docs/dyn/clouduseraccounts_alpha.groups.html
@@ -0,0 +1,760 @@
+<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="clouduseraccounts_alpha.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_alpha.groups.html">groups</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#addMember">addMember(project, groupName, body)</a></code></p>
+<p class="firstline">Adds users to the specified group.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, groupName)</a></code></p>
+<p class="firstline">Deletes the specified Group resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, groupName)</a></code></p>
+<p class="firstline">Returns the specified Group resource.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(project, resource)</a></code></p>
+<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a Group resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of groups 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>
+<p class="toc_element">
+ <code><a href="#removeMember">removeMember(project, groupName, body)</a></code></p>
+<p class="firstline">Removes users from the specified group.</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(project, resource, body)</a></code></p>
+<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="addMember">addMember(project, groupName, body)</code>
+ <pre>Adds users to the specified group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ groupName: string, Name of the group for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "users": [ # Fully-qualified URLs of the User resources to add.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, groupName)</code>
+ <pre>Deletes the specified Group resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ groupName: string, Name of the Group resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, groupName)</code>
+ <pre>Returns the specified Group resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ groupName: string, Name of the Group resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Group resource.
+ "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "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="getIamPolicy">getIamPolicy(project, resource)</code>
+ <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
+ "A String",
+ ],
+ "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # The object of the condition. Exactly one of these must be set.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a Group resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A Group resource.
+ "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of groups contained within the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
+
+The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Group resources.
+ { # A Group resource.
+ "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ },
+ ],
+ "kind": "clouduseraccounts#groupList", # [Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
+ }</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="removeMember">removeMember(project, groupName, body)</code>
+ <pre>Removes users from the specified group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ groupName: string, Name of the group for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "users": [ # Fully-qualified URLs of the User resources to remove.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body)</code>
+ <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
+ "A String",
+ ],
+ "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # The object of the condition. Exactly one of these must be set.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
+ "A String",
+ ],
+ "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # The object of the condition. Exactly one of these must be set.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/computeaccounts_alpha.html b/docs/dyn/clouduseraccounts_alpha.html
similarity index 85%
rename from docs/dyn/computeaccounts_alpha.html
rename to docs/dyn/clouduseraccounts_alpha.html
index 938942e..e8c3c7f 100644
--- a/docs/dyn/computeaccounts_alpha.html
+++ b/docs/dyn/clouduseraccounts_alpha.html
@@ -72,25 +72,25 @@
</style>
-<h1><a href="computeaccounts_alpha.html">Compute Accounts API</a></h1>
+<h1><a href="clouduseraccounts_alpha.html">Cloud User Accounts API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.globalAccountsOperations.html">globalAccountsOperations()</a></code>
+ <code><a href="clouduseraccounts_alpha.globalAccountsOperations.html">globalAccountsOperations()</a></code>
</p>
<p class="firstline">Returns the globalAccountsOperations Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.groups.html">groups()</a></code>
+ <code><a href="clouduseraccounts_alpha.groups.html">groups()</a></code>
</p>
<p class="firstline">Returns the groups Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.linux.html">linux()</a></code>
+ <code><a href="clouduseraccounts_alpha.linux.html">linux()</a></code>
</p>
<p class="firstline">Returns the linux Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.users.html">users()</a></code>
+ <code><a href="clouduseraccounts_alpha.users.html">users()</a></code>
</p>
<p class="firstline">Returns the users Resource.</p>
diff --git a/docs/dyn/clouduseraccounts_alpha.linux.html b/docs/dyn/clouduseraccounts_alpha.linux.html
new file mode 100644
index 0000000..6cec9fa
--- /dev/null
+++ b/docs/dyn/clouduseraccounts_alpha.linux.html
@@ -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="clouduseraccounts_alpha.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_alpha.linux.html">linux</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#getAuthorizedKeysView">getAuthorizedKeysView(project, zone, user, instance, login=None)</a></code></p>
+<p class="firstline">Returns a list of authorized public keys for a specific user account.</p>
+<p class="toc_element">
+ <code><a href="#getLinuxAccountViews">getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)</a></code></p>
+<p class="firstline">Retrieves a list of user accounts for an instance within a specific project.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="getAuthorizedKeysView">getAuthorizedKeysView(project, zone, user, instance, login=None)</code>
+ <pre>Returns a list of authorized public keys for a specific user account.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ user: string, The user account for which you want to get a list of authorized public keys. (required)
+ instance: string, The fully-qualified URL of the virtual machine requesting the view. (required)
+ login: boolean, Whether the view was requested as part of a user-initiated login.
+
+Returns:
+ An object of the form:
+
+ {
+ "resource": { # A list of authorized public keys for a user account. # [Output Only] A list of authorized public keys for a user.
+ "keys": [ # [Output Only] The list of authorized public keys in SSH format.
+ "A String",
+ ],
+ "sudoer": True or False, # [Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getLinuxAccountViews">getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)</code>
+ <pre>Retrieves a list of user accounts for an instance within a specific project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ instance: string, The fully-qualified URL of the virtual machine requesting the views. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
+
+The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+
+Returns:
+ An object of the form:
+
+ {
+ "resource": { # A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API. # [Output Only] A list of authorized user accounts and groups.
+ "kind": "clouduseraccounts#linuxAccountViews", # [Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.
+ "userViews": [ # [Output Only] A list of all users within a project.
+ { # A detailed view of a Linux user account.
+ "username": "A String", # [Output Only] The username of the account.
+ "shell": "A String", # [Output Only] The path to the login shell for this account.
+ "uid": 42, # [Output Only] User ID.
+ "gid": 42, # [Output Only] User's default group ID.
+ "gecos": "A String", # [Output Only] The GECOS (user information) entry for this account.
+ "homeDirectory": "A String", # [Output Only] The path to the home directory for this account.
+ },
+ ],
+ "groupViews": [ # [Output Only] A list of all groups within a project.
+ { # A detailed view of a Linux group.
+ "groupName": "A String", # [Output Only] Group name.
+ "gid": 42, # [Output Only] The Group ID.
+ "members": [ # [Output Only] List of user accounts that belong to the group.
+ "A String",
+ ],
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/clouduseraccounts_alpha.users.html b/docs/dyn/clouduseraccounts_alpha.users.html
new file mode 100644
index 0000000..fde1032
--- /dev/null
+++ b/docs/dyn/clouduseraccounts_alpha.users.html
@@ -0,0 +1,784 @@
+<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="clouduseraccounts_alpha.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_alpha.users.html">users</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#addPublicKey">addPublicKey(project, user, body)</a></code></p>
+<p class="firstline">Adds a public key to the specified User resource with the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, user)</a></code></p>
+<p class="firstline">Deletes the specified User resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, user)</a></code></p>
+<p class="firstline">Returns the specified User resource.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(project, resource)</a></code></p>
+<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a User resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of users 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>
+<p class="toc_element">
+ <code><a href="#removePublicKey">removePublicKey(project, user, fingerprint)</a></code></p>
+<p class="firstline">Removes the specified public key from the user.</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(project, resource, body)</a></code></p>
+<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="addPublicKey">addPublicKey(project, user, body)</code>
+ <pre>Adds a public key to the specified User resource with the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ user: string, Name of the user for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A public key for authenticating to guests.
+ "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, user)</code>
+ <pre>Deletes the specified User resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ user: string, Name of the user resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, user)</code>
+ <pre>Returns the specified User resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ user: string, Name of the user resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A User resource.
+ "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "publicKeys": [ # [Output Only] Public keys that this user may use to login.
+ { # A public key for authenticating to guests.
+ "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
+ },
+ ],
+ "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
+ "A String",
+ ],
+ "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "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="getIamPolicy">getIamPolicy(project, resource)</code>
+ <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
+ "A String",
+ ],
+ "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # The object of the condition. Exactly one of these must be set.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a User resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A User resource.
+ "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "publicKeys": [ # [Output Only] Public keys that this user may use to login.
+ { # A public key for authenticating to guests.
+ "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
+ },
+ ],
+ "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
+ "A String",
+ ],
+ "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of users contained within the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
+
+The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of User resources.
+ { # A User resource.
+ "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "publicKeys": [ # [Output Only] Public keys that this user may use to login.
+ { # A public key for authenticating to guests.
+ "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
+ },
+ ],
+ "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
+ "A String",
+ ],
+ "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ },
+ ],
+ "kind": "clouduseraccounts#userList", # [Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
+ }</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="removePublicKey">removePublicKey(project, user, fingerprint)</code>
+ <pre>Removes the specified public key from the user.
+
+Args:
+ project: string, Project ID for this request. (required)
+ user: string, Name of the user for this request. (required)
+ fingerprint: string, The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body)</code>
+ <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
+ "A String",
+ ],
+ "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # The object of the condition. Exactly one of these must be set.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries.
+ "A String",
+ ],
+ "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # The object of the condition. Exactly one of these must be set.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.operations.html b/docs/dyn/clouduseraccounts_beta.globalAccountsOperations.html
similarity index 83%
rename from docs/dyn/serviceregistry_alpha.operations.html
rename to docs/dyn/clouduseraccounts_beta.globalAccountsOperations.html
index eec2283..f55e515 100644
--- a/docs/dyn/serviceregistry_alpha.operations.html
+++ b/docs/dyn/clouduseraccounts_beta.globalAccountsOperations.html
@@ -72,25 +72,38 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.operations.html">operations</a></h1>
+<h1><a href="clouduseraccounts_beta.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_beta.globalAccountsOperations.html">globalAccountsOperations</a></h1>
<h2>Instance Methods</h2>
<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">Gets information about a specific operation.</p>
+<p class="firstline">Retrieves the specified operation resource.</p>
<p class="toc_element">
<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists all operations for a project.</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="get">get(project, operation)</code>
- <pre>Gets information about a specific operation.
+ <code class="details" id="delete">delete(project, operation)</code>
+ <pre>Deletes the specified operation resource.
Args:
- project: string, The project ID for this request. (required)
- operation: string, The name of the operation for this request. (required)
+ project: string, Project ID for this request. (required)
+ operation: string, Name of the Operations 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, Project ID for this request. (required)
+ operation: string, Name of the Operations resource to return. (required)
Returns:
An object of the form:
@@ -124,7 +137,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -144,10 +157,10 @@
<div class="method">
<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all operations for a project.
+ <pre>Retrieves the list of operation resources contained within the specified project.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -161,16 +174,16 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "operations": [ # [Output Only] Operations contained in this list response.
+ { # Contains a list of Operation resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Operation resources.
{ # An Operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] Reserved for future use.
@@ -200,7 +213,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -217,6 +230,9 @@
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
},
],
+ "kind": "clouduseraccounts#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/serviceregistry_alpha.endpoints.html b/docs/dyn/clouduseraccounts_beta.groups.html
similarity index 65%
copy from docs/dyn/serviceregistry_alpha.endpoints.html
copy to docs/dyn/clouduseraccounts_beta.groups.html
index fb47c39..597593b 100644
--- a/docs/dyn/serviceregistry_alpha.endpoints.html
+++ b/docs/dyn/clouduseraccounts_beta.groups.html
@@ -72,143 +72,44 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.endpoints.html">endpoints</a></h1>
+<h1><a href="clouduseraccounts_beta.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_beta.groups.html">groups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(project, endpoint)</a></code></p>
-<p class="firstline">Deletes an endpoint.</p>
+ <code><a href="#addMember">addMember(project, groupName, body)</a></code></p>
+<p class="firstline">Adds users to the specified group.</p>
<p class="toc_element">
- <code><a href="#get">get(project, endpoint)</a></code></p>
-<p class="firstline">Gets an endpoint.</p>
+ <code><a href="#delete">delete(project, groupName)</a></code></p>
+<p class="firstline">Deletes the specified Group resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, groupName)</a></code></p>
+<p class="firstline">Returns the specified Group resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates an endpoint.</p>
+<p class="firstline">Creates a Group resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists endpoints for a project.</p>
+<p class="firstline">Retrieves the list of groups 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>
<p class="toc_element">
- <code><a href="#patch">patch(project, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(project, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint.</p>
+ <code><a href="#removeMember">removeMember(project, groupName, body)</a></code></p>
+<p class="firstline">Removes users from the specified group.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(project, endpoint)</code>
- <pre>Deletes an endpoint.
+ <code class="details" id="addMember">addMember(project, groupName, body)</code>
+ <pre>Adds users to the specified group.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
-
-Returns:
- An object of the form:
-
- { # An Operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
- "clientOperationId": "A String", # [Output Only] Reserved for future use.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
- "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(project, endpoint)</code>
- <pre>Gets an endpoint.
-
-Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
-
-Returns:
- An object of the form:
-
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(project, body)</code>
- <pre>Creates an endpoint.
-
-Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
+ groupName: string, Name of the group for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+{
+ "users": [ # Fully-qualified URLs of the User resources to add.
+ "A String",
+ ],
}
@@ -244,7 +145,161 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, groupName)</code>
+ <pre>Deletes the specified Group resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ groupName: string, Name of the Group resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, groupName)</code>
+ <pre>Returns the specified Group resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ groupName: string, Name of the Group resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Group resource.
+ "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "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 Group resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A Group resource.
+ "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -264,10 +319,10 @@
<div class="method">
<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists endpoints for a project.
+ <pre>Retrieves the list of groups contained within the specified project.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -281,34 +336,31 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 6
- "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
- "endpoints": [ # The endpoints contained in this response.
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ {
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Group resources.
+ { # A Group resource.
+ "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
+ "A String",
+ ],
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
},
],
+ "kind": "clouduseraccounts#groupList", # [Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
@@ -327,31 +379,19 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, endpoint, body)</code>
- <pre>Updates an endpoint. This method supports patch semantics.
+ <code class="details" id="removeMember">removeMember(project, groupName, body)</code>
+ <pre>Removes users from the specified group.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ groupName: string, Name of the group for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+{
+ "users": [ # Fully-qualified URLs of the User resources to remove.
+ "A String",
+ ],
}
@@ -387,86 +427,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(project, endpoint, body)</code>
- <pre>Updates an endpoint.
-
-Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- }
-
-
-Returns:
- An object of the form:
-
- { # An Operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
- "clientOperationId": "A String", # [Output Only] Reserved for future use.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
- "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
diff --git a/docs/dyn/computeaccounts_alpha.html b/docs/dyn/clouduseraccounts_beta.html
similarity index 84%
copy from docs/dyn/computeaccounts_alpha.html
copy to docs/dyn/clouduseraccounts_beta.html
index 938942e..b397b51 100644
--- a/docs/dyn/computeaccounts_alpha.html
+++ b/docs/dyn/clouduseraccounts_beta.html
@@ -72,25 +72,25 @@
</style>
-<h1><a href="computeaccounts_alpha.html">Compute Accounts API</a></h1>
+<h1><a href="clouduseraccounts_beta.html">Cloud User Accounts API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.globalAccountsOperations.html">globalAccountsOperations()</a></code>
+ <code><a href="clouduseraccounts_beta.globalAccountsOperations.html">globalAccountsOperations()</a></code>
</p>
<p class="firstline">Returns the globalAccountsOperations Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.groups.html">groups()</a></code>
+ <code><a href="clouduseraccounts_beta.groups.html">groups()</a></code>
</p>
<p class="firstline">Returns the groups Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.linux.html">linux()</a></code>
+ <code><a href="clouduseraccounts_beta.linux.html">linux()</a></code>
</p>
<p class="firstline">Returns the linux Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.users.html">users()</a></code>
+ <code><a href="clouduseraccounts_beta.users.html">users()</a></code>
</p>
<p class="firstline">Returns the users Resource.</p>
diff --git a/docs/dyn/clouduseraccounts_beta.linux.html b/docs/dyn/clouduseraccounts_beta.linux.html
new file mode 100644
index 0000000..2dba669
--- /dev/null
+++ b/docs/dyn/clouduseraccounts_beta.linux.html
@@ -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="clouduseraccounts_beta.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_beta.linux.html">linux</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#getAuthorizedKeysView">getAuthorizedKeysView(project, zone, user, instance, login=None)</a></code></p>
+<p class="firstline">Returns a list of authorized public keys for a specific user account.</p>
+<p class="toc_element">
+ <code><a href="#getLinuxAccountViews">getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)</a></code></p>
+<p class="firstline">Retrieves a list of user accounts for an instance within a specific project.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="getAuthorizedKeysView">getAuthorizedKeysView(project, zone, user, instance, login=None)</code>
+ <pre>Returns a list of authorized public keys for a specific user account.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ user: string, The user account for which you want to get a list of authorized public keys. (required)
+ instance: string, The fully-qualified URL of the virtual machine requesting the view. (required)
+ login: boolean, Whether the view was requested as part of a user-initiated login.
+
+Returns:
+ An object of the form:
+
+ {
+ "resource": { # A list of authorized public keys for a user account. # [Output Only] A list of authorized public keys for a user.
+ "keys": [ # [Output Only] The list of authorized public keys in SSH format.
+ "A String",
+ ],
+ "sudoer": True or False, # [Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getLinuxAccountViews">getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)</code>
+ <pre>Retrieves a list of user accounts for an instance within a specific project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ instance: string, The fully-qualified URL of the virtual machine requesting the views. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
+
+The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+
+Returns:
+ An object of the form:
+
+ {
+ "resource": { # A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API. # [Output Only] A list of authorized user accounts and groups.
+ "kind": "clouduseraccounts#linuxAccountViews", # [Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.
+ "userViews": [ # [Output Only] A list of all users within a project.
+ { # A detailed view of a Linux user account.
+ "username": "A String", # [Output Only] The username of the account.
+ "shell": "A String", # [Output Only] The path to the login shell for this account.
+ "uid": 42, # [Output Only] User ID.
+ "gid": 42, # [Output Only] User's default group ID.
+ "gecos": "A String", # [Output Only] The GECOS (user information) entry for this account.
+ "homeDirectory": "A String", # [Output Only] The path to the home directory for this account.
+ },
+ ],
+ "groupViews": [ # [Output Only] A list of all groups within a project.
+ { # A detailed view of a Linux group.
+ "groupName": "A String", # [Output Only] Group name.
+ "gid": 42, # [Output Only] The Group ID.
+ "members": [ # [Output Only] List of user accounts that belong to the group.
+ "A String",
+ ],
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.endpoints.html b/docs/dyn/clouduseraccounts_beta.users.html
similarity index 65%
copy from docs/dyn/serviceregistry_alpha.endpoints.html
copy to docs/dyn/clouduseraccounts_beta.users.html
index fb47c39..1b9426a 100644
--- a/docs/dyn/serviceregistry_alpha.endpoints.html
+++ b/docs/dyn/clouduseraccounts_beta.users.html
@@ -72,37 +72,48 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.endpoints.html">endpoints</a></h1>
+<h1><a href="clouduseraccounts_beta.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_beta.users.html">users</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(project, endpoint)</a></code></p>
-<p class="firstline">Deletes an endpoint.</p>
+ <code><a href="#addPublicKey">addPublicKey(project, user, body)</a></code></p>
+<p class="firstline">Adds a public key to the specified User resource with the data included in the request.</p>
<p class="toc_element">
- <code><a href="#get">get(project, endpoint)</a></code></p>
-<p class="firstline">Gets an endpoint.</p>
+ <code><a href="#delete">delete(project, user)</a></code></p>
+<p class="firstline">Deletes the specified User resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, user)</a></code></p>
+<p class="firstline">Returns the specified User resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates an endpoint.</p>
+<p class="firstline">Creates a User resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists endpoints for a project.</p>
+<p class="firstline">Retrieves a list of users 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>
<p class="toc_element">
- <code><a href="#patch">patch(project, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(project, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint.</p>
+ <code><a href="#removePublicKey">removePublicKey(project, user, fingerprint)</a></code></p>
+<p class="firstline">Removes the specified public key from the user.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(project, endpoint)</code>
- <pre>Deletes an endpoint.
+ <code class="details" id="addPublicKey">addPublicKey(project, user, body)</code>
+ <pre>Adds a public key to the specified User resource with the data included in the request.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ user: string, Name of the user for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A public key for authenticating to guests.
+ "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
+}
+
Returns:
An object of the form:
@@ -136,7 +147,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -155,60 +166,126 @@
</div>
<div class="method">
- <code class="details" id="get">get(project, endpoint)</code>
- <pre>Gets an endpoint.
+ <code class="details" id="delete">delete(project, user)</code>
+ <pre>Deletes the specified User resource.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ user: string, Name of the user resource to delete. (required)
Returns:
An object of the form:
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
},
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, user)</code>
+ <pre>Returns the specified User resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ user: string, Name of the user resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A User resource.
+ "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "publicKeys": [ # [Output Only] Public keys that this user may use to login.
+ { # A public key for authenticating to guests.
+ "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
+ },
+ ],
+ "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
+ "A String",
+ ],
+ "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "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 an endpoint.
+ <pre>Creates a User resource in the specified project using the data included in the request.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+{ # A User resource.
+ "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "publicKeys": [ # [Output Only] Public keys that this user may use to login.
+ { # A public key for authenticating to guests.
+ "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
+ },
+ ],
+ "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
+ "A String",
+ ],
+ "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
}
@@ -244,7 +321,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -264,10 +341,10 @@
<div class="method">
<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists endpoints for a project.
+ <pre>Retrieves a list of users contained within the specified project.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -281,34 +358,41 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 6
- "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
- "endpoints": [ # The endpoints contained in this response.
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ {
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of User resources.
+ { # A User resource.
+ "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "publicKeys": [ # [Output Only] Public keys that this user may use to login.
+ { # A public key for authenticating to guests.
+ "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
+ },
+ ],
+ "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
+ "A String",
+ ],
+ "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
},
],
+ "kind": "clouduseraccounts#userList", # [Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
@@ -327,33 +411,13 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, endpoint, body)</code>
- <pre>Updates an endpoint. This method supports patch semantics.
+ <code class="details" id="removePublicKey">removePublicKey(project, user, fingerprint)</code>
+ <pre>Removes the specified public key from the user.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- }
-
+ project: string, Project ID for this request. (required)
+ user: string, Name of the user for this request. (required)
+ fingerprint: string, The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key. (required)
Returns:
An object of the form:
@@ -387,86 +451,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(project, endpoint, body)</code>
- <pre>Updates an endpoint.
-
-Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- }
-
-
-Returns:
- An object of the form:
-
- { # An Operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
- "clientOperationId": "A String", # [Output Only] Reserved for future use.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
- "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
diff --git a/docs/dyn/serviceregistry_alpha.operations.html b/docs/dyn/clouduseraccounts_vm_beta.globalAccountsOperations.html
similarity index 83%
copy from docs/dyn/serviceregistry_alpha.operations.html
copy to docs/dyn/clouduseraccounts_vm_beta.globalAccountsOperations.html
index eec2283..431cfbf 100644
--- a/docs/dyn/serviceregistry_alpha.operations.html
+++ b/docs/dyn/clouduseraccounts_vm_beta.globalAccountsOperations.html
@@ -72,25 +72,38 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.operations.html">operations</a></h1>
+<h1><a href="clouduseraccounts_vm_beta.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_vm_beta.globalAccountsOperations.html">globalAccountsOperations</a></h1>
<h2>Instance Methods</h2>
<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">Gets information about a specific operation.</p>
+<p class="firstline">Retrieves the specified operation resource.</p>
<p class="toc_element">
<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists all operations for a project.</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="get">get(project, operation)</code>
- <pre>Gets information about a specific operation.
+ <code class="details" id="delete">delete(project, operation)</code>
+ <pre>Deletes the specified operation resource.
Args:
- project: string, The project ID for this request. (required)
- operation: string, The name of the operation for this request. (required)
+ project: string, Project ID for this request. (required)
+ operation: string, Name of the Operations 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, Project ID for this request. (required)
+ operation: string, Name of the Operations resource to return. (required)
Returns:
An object of the form:
@@ -124,7 +137,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -144,10 +157,10 @@
<div class="method">
<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all operations for a project.
+ <pre>Retrieves the list of operation resources contained within the specified project.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -161,16 +174,16 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "operations": [ # [Output Only] Operations contained in this list response.
+ { # Contains a list of Operation resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Operation resources.
{ # An Operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] Reserved for future use.
@@ -200,7 +213,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -217,6 +230,9 @@
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
},
],
+ "kind": "clouduseraccounts#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/serviceregistry_alpha.endpoints.html b/docs/dyn/clouduseraccounts_vm_beta.groups.html
similarity index 65%
copy from docs/dyn/serviceregistry_alpha.endpoints.html
copy to docs/dyn/clouduseraccounts_vm_beta.groups.html
index fb47c39..0f97b92 100644
--- a/docs/dyn/serviceregistry_alpha.endpoints.html
+++ b/docs/dyn/clouduseraccounts_vm_beta.groups.html
@@ -72,143 +72,44 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.endpoints.html">endpoints</a></h1>
+<h1><a href="clouduseraccounts_vm_beta.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_vm_beta.groups.html">groups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(project, endpoint)</a></code></p>
-<p class="firstline">Deletes an endpoint.</p>
+ <code><a href="#addMember">addMember(project, groupName, body)</a></code></p>
+<p class="firstline">Adds users to the specified group.</p>
<p class="toc_element">
- <code><a href="#get">get(project, endpoint)</a></code></p>
-<p class="firstline">Gets an endpoint.</p>
+ <code><a href="#delete">delete(project, groupName)</a></code></p>
+<p class="firstline">Deletes the specified Group resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, groupName)</a></code></p>
+<p class="firstline">Returns the specified Group resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates an endpoint.</p>
+<p class="firstline">Creates a Group resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists endpoints for a project.</p>
+<p class="firstline">Retrieves the list of groups 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>
<p class="toc_element">
- <code><a href="#patch">patch(project, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(project, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint.</p>
+ <code><a href="#removeMember">removeMember(project, groupName, body)</a></code></p>
+<p class="firstline">Removes users from the specified group.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(project, endpoint)</code>
- <pre>Deletes an endpoint.
+ <code class="details" id="addMember">addMember(project, groupName, body)</code>
+ <pre>Adds users to the specified group.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
-
-Returns:
- An object of the form:
-
- { # An Operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
- "clientOperationId": "A String", # [Output Only] Reserved for future use.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
- "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(project, endpoint)</code>
- <pre>Gets an endpoint.
-
-Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
-
-Returns:
- An object of the form:
-
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(project, body)</code>
- <pre>Creates an endpoint.
-
-Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
+ groupName: string, Name of the group for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+{
+ "users": [ # Fully-qualified URLs of the User resources to add.
+ "A String",
+ ],
}
@@ -244,7 +145,161 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, groupName)</code>
+ <pre>Deletes the specified Group resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ groupName: string, Name of the Group resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, groupName)</code>
+ <pre>Returns the specified Group resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ groupName: string, Name of the Group resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Group resource.
+ "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "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 Group resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A Group resource.
+ "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -264,10 +319,10 @@
<div class="method">
<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists endpoints for a project.
+ <pre>Retrieves the list of groups contained within the specified project.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -281,34 +336,31 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 6
- "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
- "endpoints": [ # The endpoints contained in this response.
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ {
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of Group resources.
+ { # A Group resource.
+ "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
+ "A String",
+ ],
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
},
],
+ "kind": "clouduseraccounts#groupList", # [Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
@@ -327,31 +379,19 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, endpoint, body)</code>
- <pre>Updates an endpoint. This method supports patch semantics.
+ <code class="details" id="removeMember">removeMember(project, groupName, body)</code>
+ <pre>Removes users from the specified group.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ groupName: string, Name of the group for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+{
+ "users": [ # Fully-qualified URLs of the User resources to remove.
+ "A String",
+ ],
}
@@ -387,86 +427,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(project, endpoint, body)</code>
- <pre>Updates an endpoint.
-
-Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- }
-
-
-Returns:
- An object of the form:
-
- { # An Operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
- "clientOperationId": "A String", # [Output Only] Reserved for future use.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
- "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
diff --git a/docs/dyn/computeaccounts_alpha.html b/docs/dyn/clouduseraccounts_vm_beta.html
similarity index 84%
copy from docs/dyn/computeaccounts_alpha.html
copy to docs/dyn/clouduseraccounts_vm_beta.html
index 938942e..743e6a6 100644
--- a/docs/dyn/computeaccounts_alpha.html
+++ b/docs/dyn/clouduseraccounts_vm_beta.html
@@ -72,25 +72,25 @@
</style>
-<h1><a href="computeaccounts_alpha.html">Compute Accounts API</a></h1>
+<h1><a href="clouduseraccounts_vm_beta.html">Cloud User Accounts API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.globalAccountsOperations.html">globalAccountsOperations()</a></code>
+ <code><a href="clouduseraccounts_vm_beta.globalAccountsOperations.html">globalAccountsOperations()</a></code>
</p>
<p class="firstline">Returns the globalAccountsOperations Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.groups.html">groups()</a></code>
+ <code><a href="clouduseraccounts_vm_beta.groups.html">groups()</a></code>
</p>
<p class="firstline">Returns the groups Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.linux.html">linux()</a></code>
+ <code><a href="clouduseraccounts_vm_beta.linux.html">linux()</a></code>
</p>
<p class="firstline">Returns the linux Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.users.html">users()</a></code>
+ <code><a href="clouduseraccounts_vm_beta.users.html">users()</a></code>
</p>
<p class="firstline">Returns the users Resource.</p>
diff --git a/docs/dyn/clouduseraccounts_vm_beta.linux.html b/docs/dyn/clouduseraccounts_vm_beta.linux.html
new file mode 100644
index 0000000..28d03d0
--- /dev/null
+++ b/docs/dyn/clouduseraccounts_vm_beta.linux.html
@@ -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="clouduseraccounts_vm_beta.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_vm_beta.linux.html">linux</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#getAuthorizedKeysView">getAuthorizedKeysView(project, zone, user, instance, login=None)</a></code></p>
+<p class="firstline">Returns a list of authorized public keys for a specific user account.</p>
+<p class="toc_element">
+ <code><a href="#getLinuxAccountViews">getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)</a></code></p>
+<p class="firstline">Retrieves a list of user accounts for an instance within a specific project.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="getAuthorizedKeysView">getAuthorizedKeysView(project, zone, user, instance, login=None)</code>
+ <pre>Returns a list of authorized public keys for a specific user account.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ user: string, The user account for which you want to get a list of authorized public keys. (required)
+ instance: string, The fully-qualified URL of the virtual machine requesting the view. (required)
+ login: boolean, Whether the view was requested as part of a user-initiated login.
+
+Returns:
+ An object of the form:
+
+ {
+ "resource": { # A list of authorized public keys for a user account. # [Output Only] A list of authorized public keys for a user.
+ "keys": [ # [Output Only] The list of authorized public keys in SSH format.
+ "A String",
+ ],
+ "sudoer": True or False, # [Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getLinuxAccountViews">getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)</code>
+ <pre>Retrieves a list of user accounts for an instance within a specific project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ instance: string, The fully-qualified URL of the virtual machine requesting the views. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
+
+The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+
+Returns:
+ An object of the form:
+
+ {
+ "resource": { # A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API. # [Output Only] A list of authorized user accounts and groups.
+ "kind": "clouduseraccounts#linuxAccountViews", # [Output Only] Type of the resource. Always clouduseraccounts#linuxAccountViews for Linux resources.
+ "userViews": [ # [Output Only] A list of all users within a project.
+ { # A detailed view of a Linux user account.
+ "username": "A String", # [Output Only] The username of the account.
+ "shell": "A String", # [Output Only] The path to the login shell for this account.
+ "uid": 42, # [Output Only] User ID.
+ "gid": 42, # [Output Only] User's default group ID.
+ "gecos": "A String", # [Output Only] The GECOS (user information) entry for this account.
+ "homeDirectory": "A String", # [Output Only] The path to the home directory for this account.
+ },
+ ],
+ "groupViews": [ # [Output Only] A list of all groups within a project.
+ { # A detailed view of a Linux group.
+ "groupName": "A String", # [Output Only] Group name.
+ "gid": 42, # [Output Only] The Group ID.
+ "members": [ # [Output Only] List of user accounts that belong to the group.
+ "A String",
+ ],
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.endpoints.html b/docs/dyn/clouduseraccounts_vm_beta.users.html
similarity index 65%
rename from docs/dyn/serviceregistry_alpha.endpoints.html
rename to docs/dyn/clouduseraccounts_vm_beta.users.html
index fb47c39..a4d1b05 100644
--- a/docs/dyn/serviceregistry_alpha.endpoints.html
+++ b/docs/dyn/clouduseraccounts_vm_beta.users.html
@@ -72,37 +72,48 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.endpoints.html">endpoints</a></h1>
+<h1><a href="clouduseraccounts_vm_beta.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_vm_beta.users.html">users</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(project, endpoint)</a></code></p>
-<p class="firstline">Deletes an endpoint.</p>
+ <code><a href="#addPublicKey">addPublicKey(project, user, body)</a></code></p>
+<p class="firstline">Adds a public key to the specified User resource with the data included in the request.</p>
<p class="toc_element">
- <code><a href="#get">get(project, endpoint)</a></code></p>
-<p class="firstline">Gets an endpoint.</p>
+ <code><a href="#delete">delete(project, user)</a></code></p>
+<p class="firstline">Deletes the specified User resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, user)</a></code></p>
+<p class="firstline">Returns the specified User resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates an endpoint.</p>
+<p class="firstline">Creates a User resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists endpoints for a project.</p>
+<p class="firstline">Retrieves a list of users 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>
<p class="toc_element">
- <code><a href="#patch">patch(project, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(project, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint.</p>
+ <code><a href="#removePublicKey">removePublicKey(project, user, fingerprint)</a></code></p>
+<p class="firstline">Removes the specified public key from the user.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(project, endpoint)</code>
- <pre>Deletes an endpoint.
+ <code class="details" id="addPublicKey">addPublicKey(project, user, body)</code>
+ <pre>Adds a public key to the specified User resource with the data included in the request.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ user: string, Name of the user for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A public key for authenticating to guests.
+ "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
+}
+
Returns:
An object of the form:
@@ -136,7 +147,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -155,60 +166,126 @@
</div>
<div class="method">
- <code class="details" id="get">get(project, endpoint)</code>
- <pre>Gets an endpoint.
+ <code class="details" id="delete">delete(project, user)</code>
+ <pre>Deletes the specified User resource.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ user: string, Name of the user resource to delete. (required)
Returns:
An object of the form:
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
},
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, user)</code>
+ <pre>Returns the specified User resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ user: string, Name of the user resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A User resource.
+ "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "publicKeys": [ # [Output Only] Public keys that this user may use to login.
+ { # A public key for authenticating to guests.
+ "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
+ },
+ ],
+ "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
+ "A String",
+ ],
+ "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "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 an endpoint.
+ <pre>Creates a User resource in the specified project using the data included in the request.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+{ # A User resource.
+ "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "publicKeys": [ # [Output Only] Public keys that this user may use to login.
+ { # A public key for authenticating to guests.
+ "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
+ },
+ ],
+ "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
+ "A String",
+ ],
+ "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
}
@@ -244,7 +321,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -264,10 +341,10 @@
<div class="method">
<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists endpoints for a project.
+ <pre>Retrieves a list of users contained within the specified project.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -281,34 +358,41 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 6
- "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
- "endpoints": [ # The endpoints contained in this response.
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ {
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # [Output Only] A list of User resources.
+ { # A User resource.
+ "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created.
+ "publicKeys": [ # [Output Only] Public keys that this user may use to login.
+ { # A public key for authenticating to guests.
+ "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
+ },
+ ],
+ "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
+ "A String",
+ ],
+ "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "selfLink": "A String", # [Output Only] Server defined URL for the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
},
],
+ "kind": "clouduseraccounts#userList", # [Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
@@ -327,33 +411,13 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, endpoint, body)</code>
- <pre>Updates an endpoint. This method supports patch semantics.
+ <code class="details" id="removePublicKey">removePublicKey(project, user, fingerprint)</code>
+ <pre>Removes the specified public key from the user.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- }
-
+ project: string, Project ID for this request. (required)
+ user: string, Name of the user for this request. (required)
+ fingerprint: string, The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key. (required)
Returns:
An object of the form:
@@ -387,86 +451,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(project, endpoint, body)</code>
- <pre>Updates an endpoint.
-
-Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- }
-
-
-Returns:
- An object of the form:
-
- { # An Operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
- "clientOperationId": "A String", # [Output Only] Reserved for future use.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
- "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
diff --git a/docs/dyn/compute_alpha.addresses.html b/docs/dyn/compute_alpha.addresses.html
new file mode 100644
index 0000000..1387bf9
--- /dev/null
+++ b/docs/dyn/compute_alpha.addresses.html
@@ -0,0 +1,465 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.addresses.html">addresses</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of addresses.</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, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of addresses 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of addresses.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped address lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of addresses.
+ "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "addresses": [ # [Output Only] List of addresses contained in this scope.
+ { # A reserved address resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an Address.
+ "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "address": "A String", # The static external IP address represented by this resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ },
+ },
+ "kind": "compute#addressAggregatedList", # [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, Project ID for this request. (required)
+ region: string, Name of the region for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, address)</code>
+ <pre>Returns the specified address resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for 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", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an Address.
+ "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "address": "A String", # The static external IP address represented by this resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</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, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A reserved address resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an Address.
+ "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "address": "A String", # The static external IP address represented by this resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of addresses contained within the specified region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of addresses.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of addresses.
+ { # A reserved address resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an Address.
+ "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "address": "A String", # The static external IP address represented by this resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }</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="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.autoscalers.html b/docs/dyn/compute_alpha.autoscalers.html
new file mode 100644
index 0000000..368a11e
--- /dev/null
+++ b/docs/dyn/compute_alpha.autoscalers.html
@@ -0,0 +1,855 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.autoscalers.html">autoscalers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of autoscalers.</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, zone, autoscaler)</a></code></p>
+<p class="firstline">Deletes the specified autoscaler.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, zone, autoscaler)</a></code></p>
+<p class="firstline">Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, zone, body)</a></code></p>
+<p class="firstline">Creates an autoscaler in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of autoscalers 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>
+<p class="toc_element">
+ <code><a href="#patch">patch(project, zone, autoscaler, body)</a></code></p>
+<p class="firstline">Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, zone, body, autoscaler=None)</a></code></p>
+<p class="firstline">Updates an autoscaler in the specified project using the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of autoscalers.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # A map of scoped autoscaler lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of autoscalers.
+ "warning": { # [Output Only] Informational warning which replaces the list of autoscalers when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "autoscalers": [ # [Output Only] List of autoscalers contained in this scope.
+ { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
+ "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
+ "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
+ "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
+ "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
+ "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
+ },
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ },
+ },
+ "kind": "compute#autoscalerAggregatedList", # [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, zone, autoscaler)</code>
+ <pre>Deletes the specified autoscaler.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ autoscaler: string, Name of the autoscaler to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, zone, autoscaler)</code>
+ <pre>Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ autoscaler: string, Name of the autoscaler to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
+ "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
+ "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
+ "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
+ "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
+ "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
+ },
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, zone, body)</code>
+ <pre>Creates an autoscaler in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
+ "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
+ "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
+ "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
+ "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
+ "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
+ },
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of autoscalers contained within the specified zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of Autoscaler resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of Autoscaler resources.
+ { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
+ "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
+ "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
+ "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
+ "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
+ "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
+ },
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#autoscalerList", # [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, zone, autoscaler, body)</code>
+ <pre>Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ autoscaler: string, Name of the autoscaler to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
+ "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
+ "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
+ "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
+ "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
+ "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
+ },
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, zone, body, autoscaler=None)</code>
+ <pre>Updates an autoscaler in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
+ "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
+ "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
+ "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
+ "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
+ "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
+ },
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+ autoscaler: string, Name of the autoscaler to update.
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.backendBuckets.html b/docs/dyn/compute_alpha.backendBuckets.html
new file mode 100644
index 0000000..a0bba70
--- /dev/null
+++ b/docs/dyn/compute_alpha.backendBuckets.html
@@ -0,0 +1,767 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.backendBuckets.html">backendBuckets</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, backendBucket)</a></code></p>
+<p class="firstline">Deletes the specified BackendBucket resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, backendBucket)</a></code></p>
+<p class="firstline">Returns the specified BackendBucket resource. Get a list of available backend buckets by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(project, resource)</a></code></p>
+<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a BackendBucket resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of BackendBucket 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, backendBucket, body)</a></code></p>
+<p class="firstline">Updates the specified BackendBucket resource with the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(project, resource, body)</a></code></p>
+<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, backendBucket, body)</a></code></p>
+<p class="firstline">Updates the specified BackendBucket resource with the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, backendBucket)</code>
+ <pre>Deletes the specified BackendBucket resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ backendBucket: string, Name of the BackendBucket resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, backendBucket)</code>
+ <pre>Returns the specified BackendBucket resource. Get a list of available backend buckets by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ backendBucket: string, Name of the BackendBucket resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A BackendBucket resource. This resource defines a Cloud Storage bucket.
+ "kind": "compute#backendBucket", # Type of the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
+ "bucketName": "A String", # Cloud Storage bucket name.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code>
+ <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a BackendBucket resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
+ "kind": "compute#backendBucket", # Type of the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
+ "bucketName": "A String", # Cloud Storage bucket name.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of BackendBucket resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of BackendBucket resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # A list of BackendBucket resources.
+ { # A BackendBucket resource. This resource defines a Cloud Storage bucket.
+ "kind": "compute#backendBucket", # Type of the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
+ "bucketName": "A String", # Cloud Storage bucket name.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#backendBucketList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, backendBucket, body)</code>
+ <pre>Updates the specified BackendBucket resource with the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ backendBucket: string, Name of the BackendBucket resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
+ "kind": "compute#backendBucket", # Type of the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
+ "bucketName": "A String", # Cloud Storage bucket name.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body)</code>
+ <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, backendBucket, body)</code>
+ <pre>Updates the specified BackendBucket resource with the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ backendBucket: string, Name of the BackendBucket resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
+ "kind": "compute#backendBucket", # Type of the resource.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
+ "bucketName": "A String", # Cloud Storage bucket name.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html
new file mode 100644
index 0000000..f2dbbc4
--- /dev/null
+++ b/docs/dyn/compute_alpha.backendServices.html
@@ -0,0 +1,1134 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.backendServices.html">backendServices</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of all BackendService resources, regional and global, available to the specified project.</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, backendService)</a></code></p>
+<p class="firstline">Deletes the specified BackendService resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, backendService)</a></code></p>
+<p class="firstline">Returns the specified BackendService resource. Get a list of available backend services by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#getHealth">getHealth(project, backendService, body)</a></code></p>
+<p class="firstline">Gets the most recent health check results for this BackendService.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of BackendService 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, backendService, body)</a></code></p>
+<p class="firstline">Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, backendService, body)</a></code></p>
+<p class="firstline">Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of all BackendService resources, regional and global, available to the specified project.
+
+Args:
+ project: string, Name of the project scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of BackendServicesScopedList.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": { # A map of scoped BackendService lists.
+ "a_key": { # Name of the scope containing this set of BackendServices.
+ "warning": { # Informational warning which replaces the list of backend services when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "backendServices": [ # List of BackendServices contained in this scope.
+ { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
+ "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
+ "A String",
+ ],
+ },
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "loadBalancingScheme": "A String",
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
+ "oauth2ClientId": "A String",
+ "enabled": True or False,
+ "oauth2ClientSecret": "A String",
+ "oauth2ClientSecretSha256": "A String",
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ },
+ },
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ },
+ ],
+ },
+ },
+ "kind": "compute#backendServiceAggregatedList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, backendService)</code>
+ <pre>Deletes the specified BackendService resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ backendService: string, Name of the BackendService resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, backendService)</code>
+ <pre>Returns the specified BackendService resource. Get a list of available backend services by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ backendService: string, Name of the BackendService resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
+ "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
+ "A String",
+ ],
+ },
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "loadBalancingScheme": "A String",
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
+ "oauth2ClientId": "A String",
+ "enabled": True or False,
+ "oauth2ClientSecret": "A String",
+ "oauth2ClientSecretSha256": "A String",
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ },
+ },
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getHealth">getHealth(project, backendService, body)</code>
+ <pre>Gets the most recent health check results for this BackendService.
+
+Args:
+ project: string, A parameter (required)
+ backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "group": "A String", # A URI referencing one of the instance groups listed in the backend service.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
+ "healthStatus": [
+ {
+ "instance": "A String", # URL of the instance resource.
+ "healthState": "A String", # Health state of the instance.
+ "ipAddress": "A String", # The IP address represented by this resource.
+ "port": 42, # The port on the instance.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
+ "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
+ "A String",
+ ],
+ },
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "loadBalancingScheme": "A String",
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
+ "oauth2ClientId": "A String",
+ "enabled": True or False,
+ "oauth2ClientSecret": "A String",
+ "oauth2ClientSecretSha256": "A String",
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ },
+ },
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of BackendService resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of BackendService resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # A list of BackendService resources.
+ { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
+ "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
+ "A String",
+ ],
+ },
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "loadBalancingScheme": "A String",
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
+ "oauth2ClientId": "A String",
+ "enabled": True or False,
+ "oauth2ClientSecret": "A String",
+ "oauth2ClientSecretSha256": "A String",
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ },
+ },
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ },
+ ],
+ "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, backendService, body)</code>
+ <pre>Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ backendService: string, Name of the BackendService resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
+ "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
+ "A String",
+ ],
+ },
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "loadBalancingScheme": "A String",
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
+ "oauth2ClientId": "A String",
+ "enabled": True or False,
+ "oauth2ClientSecret": "A String",
+ "oauth2ClientSecretSha256": "A String",
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ },
+ },
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, backendService, body)</code>
+ <pre>Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ backendService: string, Name of the BackendService resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
+ "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
+ "A String",
+ ],
+ },
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "loadBalancingScheme": "A String",
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
+ "oauth2ClientId": "A String",
+ "enabled": True or False,
+ "oauth2ClientSecret": "A String",
+ "oauth2ClientSecretSha256": "A String",
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ },
+ },
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.clientSslPolicies.html b/docs/dyn/compute_alpha.clientSslPolicies.html
new file mode 100644
index 0000000..405e474
--- /dev/null
+++ b/docs/dyn/compute_alpha.clientSslPolicies.html
@@ -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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.clientSslPolicies.html">clientSslPolicies</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.diskTypes.html b/docs/dyn/compute_alpha.diskTypes.html
new file mode 100644
index 0000000..4d1bd5a
--- /dev/null
+++ b/docs/dyn/compute_alpha.diskTypes.html
@@ -0,0 +1,277 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.diskTypes.html">diskTypes</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of disk types.</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, diskType)</a></code></p>
+<p class="firstline">Returns the specified disk type. Get a list of available disk types by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of disk types 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, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of disk types.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped disk type lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of disk types.
+ "warning": { # [Output Only] Informational warning which replaces the list of disk types when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "diskTypes": [ # [Output Only] List of disk types contained in this scope.
+ { # A DiskType resource.
+ "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
+ "description": "A String", # [Output Only] An optional description of this resource.
+ "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
+ "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ },
+ },
+ "kind": "compute#diskTypeAggregatedList", # [Output Only] Type of resource. Always compute#diskTypeAggregatedList.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, diskType)</code>
+ <pre>Returns the specified disk type. Get a list of available disk types by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ diskType: string, Name of the disk type to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A DiskType resource.
+ "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
+ "description": "A String", # [Output Only] An optional description of this resource.
+ "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
+ "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of disk types available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of disk types.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Disk Type resources.
+ { # A DiskType resource.
+ "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
+ "description": "A String", # [Output Only] An optional description of this resource.
+ "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
+ "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ "kind": "compute#diskTypeList", # [Output Only] Type of resource. Always compute#diskTypeList for disk types.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html
new file mode 100644
index 0000000..f87e107
--- /dev/null
+++ b/docs/dyn/compute_alpha.disks.html
@@ -0,0 +1,1011 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.disks.html">disks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of persistent disks.</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, guestFlush=None)</a></code></p>
+<p class="firstline">Creates a snapshot of a specified persistent disk.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, zone, disk)</a></code></p>
+<p class="firstline">Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, zone, disk)</a></code></p>
+<p class="firstline">Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.</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 in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of persistent disks 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>
+<p class="toc_element">
+ <code><a href="#resize">resize(project, zone, disk, body)</a></code></p>
+<p class="firstline">Resizes the specified persistent disk.</p>
+<p class="toc_element">
+ <code><a href="#setLabels">setLabels(project, zone, resource, body)</a></code></p>
+<p class="firstline">Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of persistent disks.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped disk lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of disks.
+ "disks": [ # [Output Only] List of disks contained in this scope.
+ { # A Disk resource.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "licenses": [ # Any applicable publicly visible licenses.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "A String",
+ ],
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
+ #
+ # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
+ "status": "A String", # [Output Only] The status of disk creation.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a disk.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
+ "A String",
+ ],
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
+ "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
+ "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "options": "A String", # Internal use only.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ },
+ ],
+ "warning": { # [Output Only] Informational warning which replaces the list of disks when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#diskAggregatedList", # [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, guestFlush=None)</code>
+ <pre>Creates a snapshot of a specified persistent disk.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the persistent disk to snapshot. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A persistent disk snapshot resource.
+ "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
+ "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
+ "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
+ #
+ # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a snapshot.
+ "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
+ "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+ guestFlush: boolean, A parameter
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, zone, disk)</code>
+ <pre>Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the persistent disk to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, zone, disk)</code>
+ <pre>Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the persistent disk to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Disk resource.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "licenses": [ # Any applicable publicly visible licenses.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "A String",
+ ],
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
+ #
+ # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
+ "status": "A String", # [Output Only] The status of disk creation.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a disk.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
+ "A String",
+ ],
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
+ "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
+ "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "options": "A String", # Internal use only.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, zone, body, sourceImage=None)</code>
+ <pre>Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A Disk resource.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "licenses": [ # Any applicable publicly visible licenses.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "A String",
+ ],
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
+ #
+ # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
+ "status": "A String", # [Output Only] The status of disk creation.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a disk.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
+ "A String",
+ ],
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
+ "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
+ "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "options": "A String", # Internal use only.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ }
+
+ 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of persistent disks contained within the specified zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # A list of Disk resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of persistent disks.
+ { # A Disk resource.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "licenses": [ # Any applicable publicly visible licenses.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "A String",
+ ],
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
+ #
+ # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
+ "status": "A String", # [Output Only] The status of disk creation.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a disk.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
+ "A String",
+ ],
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
+ "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
+ "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "options": "A String", # Internal use only.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ },
+ ],
+ "kind": "compute#diskList", # [Output Only] Type of resource. Always compute#diskList for lists of disks.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="resize">resize(project, zone, disk, body)</code>
+ <pre>Resizes the specified persistent disk.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, The name of the persistent disk. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "sizeGb": "A String", # The new size of the persistent disk, which is specified in GB.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setLabels">setLabels(project, zone, resource, body)</code>
+ <pre>Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
+ "labels": { # The labels to set for this resource.
+ "a_key": "A String",
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.firewalls.html b/docs/dyn/compute_alpha.firewalls.html
new file mode 100644
index 0000000..0e8d304
--- /dev/null
+++ b/docs/dyn/compute_alpha.firewalls.html
@@ -0,0 +1,600 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.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.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, firewall)</a></code></p>
+<p class="firstline">Returns the specified firewall.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a firewall rule in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of firewall rules 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 rule with the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, firewall, body)</a></code></p>
+<p class="firstline">Updates the specified firewall rule 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.
+
+Args:
+ project: string, Project ID for this request. (required)
+ firewall: string, Name of the firewall rule to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, firewall)</code>
+ <pre>Returns the specified firewall.
+
+Args:
+ project: string, Project ID for this request. (required)
+ firewall: string, Name of the firewall rule to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents a Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a firewall rule in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of firewall rules available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of firewalls.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Firewall resources.
+ { # Represents a Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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 rule with the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ firewall: string, Name of the firewall rule to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, firewall, body)</code>
+ <pre>Updates the specified firewall rule with the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ firewall: string, Name of the firewall rule to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.forwardingRules.html b/docs/dyn/compute_alpha.forwardingRules.html
new file mode 100644
index 0000000..ef3d29f
--- /dev/null
+++ b/docs/dyn/compute_alpha.forwardingRules.html
@@ -0,0 +1,678 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.forwardingRules.html">forwardingRules</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of forwarding rules.</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, forwardingRule)</a></code></p>
+<p class="firstline">Deletes the specified ForwardingRule resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, forwardingRule)</a></code></p>
+<p class="firstline">Returns the specified ForwardingRule resource.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a ForwardingRule resource in the specified project and region using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of ForwardingRule resources available to the specified project and 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>
+<p class="toc_element">
+ <code><a href="#setTarget">setTarget(project, region, forwardingRule, body)</a></code></p>
+<p class="firstline">Changes target URL for forwarding rule. The new target should be of the same type as the old target.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of forwarding rules.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # A map of scoped forwarding rule lists.
+ "a_key": { # Name of the scope containing this set of addresses.
+ "forwardingRules": [ # List of forwarding rules contained in this scope.
+ { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
+ "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
+ #
+ # This field is only used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
+ #
+ # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ #
+ # This field is only used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "warning": { # Informational warning which replaces the list of forwarding rules when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#forwardingRuleAggregatedList", # [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, forwardingRule)</code>
+ <pre>Deletes the specified ForwardingRule resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ forwardingRule: string, Name of the ForwardingRule resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, forwardingRule)</code>
+ <pre>Returns the specified ForwardingRule resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ forwardingRule: string, Name of the ForwardingRule resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
+ "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
+ #
+ # This field is only used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
+ #
+ # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ #
+ # This field is only used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a ForwardingRule resource in the specified project and region using the data included in the request.
+
+Args:
+ project: string, Project ID for 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 ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
+ "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
+ #
+ # This field is only used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
+ #
+ # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ #
+ # This field is only used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of ForwardingRule resources available to the specified project and region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of ForwardingRule resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of ForwardingRule resources.
+ { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
+ "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
+ #
+ # This field is only used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
+ #
+ # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ #
+ # This field is only used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#forwardingRuleList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="setTarget">setTarget(project, region, forwardingRule, body)</code>
+ <pre>Changes target URL for forwarding rule. The new target should be of the same type as the old target.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "target": "A String",
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.globalAddresses.html b/docs/dyn/compute_alpha.globalAddresses.html
new file mode 100644
index 0000000..aab6a3c
--- /dev/null
+++ b/docs/dyn/compute_alpha.globalAddresses.html
@@ -0,0 +1,368 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.globalAddresses.html">globalAddresses</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, address)</a></code></p>
+<p class="firstline">Deletes the specified address resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, address)</a></code></p>
+<p class="firstline">Returns the specified address resource. Get a list of available addresses by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, 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, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of global addresses.</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="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, address)</code>
+ <pre>Deletes the specified address resource.
+
+Args:
+ project: string, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, address)</code>
+ <pre>Returns the specified address resource. Get a list of available addresses by making a list() request.
+
+Args:
+ project: string, Project ID for 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", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an Address.
+ "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "address": "A String", # The static external IP address represented by this resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates an address resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A reserved address resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an Address.
+ "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "address": "A String", # The static external IP address represented by this resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of global addresses.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of addresses.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of addresses.
+ { # A reserved address resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an Address.
+ "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "networkTier": "A String", # This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "address": "A String", # The static external IP address represented by this resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }</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="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.globalForwardingRules.html b/docs/dyn/compute_alpha.globalForwardingRules.html
new file mode 100644
index 0000000..60e49b4
--- /dev/null
+++ b/docs/dyn/compute_alpha.globalForwardingRules.html
@@ -0,0 +1,544 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.globalForwardingRules.html">globalForwardingRules</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, forwardingRule)</a></code></p>
+<p class="firstline">Deletes the specified ForwardingRule resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, forwardingRule)</a></code></p>
+<p class="firstline">Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a ForwardingRule resource in the specified project and region using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of ForwardingRule 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="#setTarget">setTarget(project, forwardingRule, body)</a></code></p>
+<p class="firstline">Changes target URL for forwarding rule. The new target should be of the same type as the old target.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, forwardingRule)</code>
+ <pre>Deletes the specified ForwardingRule resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ forwardingRule: string, Name of the ForwardingRule resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, forwardingRule)</code>
+ <pre>Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ forwardingRule: string, Name of the ForwardingRule resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
+ "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
+ #
+ # This field is only used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
+ #
+ # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ #
+ # This field is only used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a ForwardingRule resource in the specified project and region using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
+ "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
+ #
+ # This field is only used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
+ #
+ # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ #
+ # This field is only used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of ForwardingRule resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of ForwardingRule resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of ForwardingRule resources.
+ { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
+ "labels": { # Labels to apply to this resource. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "dnsName": "A String", # [Output Only] The internal fully qualified domain name for this Forwarding Rule.
+ #
+ # This field is only used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "dnsLabel": "A String", # An optional prefix to the DNS name for this Forwarding Rule. If specified, will be the first label of the fully qualified domain name.
+ #
+ # The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ #
+ # This field is only used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#forwardingRuleList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="setTarget">setTarget(project, forwardingRule, body)</code>
+ <pre>Changes target URL for forwarding rule. The new target should be of the same type as the old target.
+
+Args:
+ project: string, Project ID for this request. (required)
+ forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "target": "A String",
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.globalOperations.html b/docs/dyn/compute_alpha.globalOperations.html
new file mode 100644
index 0000000..534e1f6
--- /dev/null
+++ b/docs/dyn/compute_alpha.globalOperations.html
@@ -0,0 +1,369 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.globalOperations.html">globalOperations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of all operations.</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 Operations resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, operation)</a></code></p>
+<p class="firstline">Retrieves the specified Operations resource. Get a list of operations by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a 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, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of all operations.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped operation lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of operations.
+ "operations": [ # [Output Only] List of operations contained in this scope.
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ ],
+ "warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#operationAggregatedList", # [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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 Operations resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ operation: string, Name of the Operations resource to delete. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, operation)</code>
+ <pre>Retrieves the specified Operations resource. Get a list of operations by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ operation: string, Name of the Operations resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of Operation resources contained within the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of Operation resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Operation resources.
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ ],
+ "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.healthChecks.html b/docs/dyn/compute_alpha.healthChecks.html
new file mode 100644
index 0000000..221e16d
--- /dev/null
+++ b/docs/dyn/compute_alpha.healthChecks.html
@@ -0,0 +1,720 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.healthChecks.html">healthChecks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, healthCheck)</a></code></p>
+<p class="firstline">Deletes the specified HealthCheck resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, healthCheck)</a></code></p>
+<p class="firstline">Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a HealthCheck resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of HealthCheck 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, healthCheck, body)</a></code></p>
+<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, healthCheck, body)</a></code></p>
+<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, healthCheck)</code>
+ <pre>Deletes the specified HealthCheck resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ healthCheck: string, Name of the HealthCheck resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, healthCheck)</code>
+ <pre>Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ healthCheck: string, Name of the HealthCheck resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "udpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
+ "port": 42, # The UDP port number for the health check request.
+ "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "httpsHealthCheck": {
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a HealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "udpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
+ "port": 42, # The UDP port number for the health check request.
+ "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "httpsHealthCheck": {
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of HealthCheck resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of HealthCheck resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of HealthCheck resources.
+ { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "udpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
+ "port": 42, # The UDP port number for the health check request.
+ "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "httpsHealthCheck": {
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#healthCheckList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, healthCheck, body)</code>
+ <pre>Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ healthCheck: string, Name of the HealthCheck resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "udpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
+ "port": 42, # The UDP port number for the health check request.
+ "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "httpsHealthCheck": {
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, healthCheck, body)</code>
+ <pre>Updates a HealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ healthCheck: string, Name of the HealthCheck resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "udpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
+ "port": 42, # The UDP port number for the health check request.
+ "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "httpsHealthCheck": {
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.hosts.html b/docs/dyn/compute_alpha.hosts.html
new file mode 100644
index 0000000..0dfcd97
--- /dev/null
+++ b/docs/dyn/compute_alpha.hosts.html
@@ -0,0 +1,393 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.hosts.html">hosts</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource)</a></code></p>
+<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body)</a></code></p>
+<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource)</code>
+ <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body)</code>
+ <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html
new file mode 100644
index 0000000..b5c668d
--- /dev/null
+++ b/docs/dyn/compute_alpha.html
@@ -0,0 +1,343 @@
+<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_alpha.html">Compute Engine API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="compute_alpha.addresses.html">addresses()</a></code>
+</p>
+<p class="firstline">Returns the addresses Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.autoscalers.html">autoscalers()</a></code>
+</p>
+<p class="firstline">Returns the autoscalers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.backendBuckets.html">backendBuckets()</a></code>
+</p>
+<p class="firstline">Returns the backendBuckets Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.backendServices.html">backendServices()</a></code>
+</p>
+<p class="firstline">Returns the backendServices Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.clientSslPolicies.html">clientSslPolicies()</a></code>
+</p>
+<p class="firstline">Returns the clientSslPolicies Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.diskTypes.html">diskTypes()</a></code>
+</p>
+<p class="firstline">Returns the diskTypes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.disks.html">disks()</a></code>
+</p>
+<p class="firstline">Returns the disks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.firewalls.html">firewalls()</a></code>
+</p>
+<p class="firstline">Returns the firewalls Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.forwardingRules.html">forwardingRules()</a></code>
+</p>
+<p class="firstline">Returns the forwardingRules Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.globalAddresses.html">globalAddresses()</a></code>
+</p>
+<p class="firstline">Returns the globalAddresses Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.globalForwardingRules.html">globalForwardingRules()</a></code>
+</p>
+<p class="firstline">Returns the globalForwardingRules Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.globalOperations.html">globalOperations()</a></code>
+</p>
+<p class="firstline">Returns the globalOperations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.healthChecks.html">healthChecks()</a></code>
+</p>
+<p class="firstline">Returns the healthChecks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.hosts.html">hosts()</a></code>
+</p>
+<p class="firstline">Returns the hosts Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.httpHealthChecks.html">httpHealthChecks()</a></code>
+</p>
+<p class="firstline">Returns the httpHealthChecks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.httpsHealthChecks.html">httpsHealthChecks()</a></code>
+</p>
+<p class="firstline">Returns the httpsHealthChecks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.images.html">images()</a></code>
+</p>
+<p class="firstline">Returns the images Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.instanceGroupManagers.html">instanceGroupManagers()</a></code>
+</p>
+<p class="firstline">Returns the instanceGroupManagers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.instanceGroups.html">instanceGroups()</a></code>
+</p>
+<p class="firstline">Returns the instanceGroups Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.instanceTemplates.html">instanceTemplates()</a></code>
+</p>
+<p class="firstline">Returns the instanceTemplates Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.instances.html">instances()</a></code>
+</p>
+<p class="firstline">Returns the instances Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.licenses.html">licenses()</a></code>
+</p>
+<p class="firstline">Returns the licenses Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.machineTypes.html">machineTypes()</a></code>
+</p>
+<p class="firstline">Returns the machineTypes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.networks.html">networks()</a></code>
+</p>
+<p class="firstline">Returns the networks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.projects.html">projects()</a></code>
+</p>
+<p class="firstline">Returns the projects Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.regionAutoscalers.html">regionAutoscalers()</a></code>
+</p>
+<p class="firstline">Returns the regionAutoscalers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.regionBackendServices.html">regionBackendServices()</a></code>
+</p>
+<p class="firstline">Returns the regionBackendServices Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.regionDiskTypes.html">regionDiskTypes()</a></code>
+</p>
+<p class="firstline">Returns the regionDiskTypes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.regionDisks.html">regionDisks()</a></code>
+</p>
+<p class="firstline">Returns the regionDisks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.regionInstanceGroupManagers.html">regionInstanceGroupManagers()</a></code>
+</p>
+<p class="firstline">Returns the regionInstanceGroupManagers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.regionInstanceGroups.html">regionInstanceGroups()</a></code>
+</p>
+<p class="firstline">Returns the regionInstanceGroups Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.regionOperations.html">regionOperations()</a></code>
+</p>
+<p class="firstline">Returns the regionOperations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.regions.html">regions()</a></code>
+</p>
+<p class="firstline">Returns the regions Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.routers.html">routers()</a></code>
+</p>
+<p class="firstline">Returns the routers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.routes.html">routes()</a></code>
+</p>
+<p class="firstline">Returns the routes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.snapshots.html">snapshots()</a></code>
+</p>
+<p class="firstline">Returns the snapshots Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.sslCertificates.html">sslCertificates()</a></code>
+</p>
+<p class="firstline">Returns the sslCertificates Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.subnetworks.html">subnetworks()</a></code>
+</p>
+<p class="firstline">Returns the subnetworks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.targetHttpProxies.html">targetHttpProxies()</a></code>
+</p>
+<p class="firstline">Returns the targetHttpProxies Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.targetHttpsProxies.html">targetHttpsProxies()</a></code>
+</p>
+<p class="firstline">Returns the targetHttpsProxies Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.targetInstances.html">targetInstances()</a></code>
+</p>
+<p class="firstline">Returns the targetInstances Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.targetPools.html">targetPools()</a></code>
+</p>
+<p class="firstline">Returns the targetPools Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.targetSslProxies.html">targetSslProxies()</a></code>
+</p>
+<p class="firstline">Returns the targetSslProxies Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.targetTcpProxies.html">targetTcpProxies()</a></code>
+</p>
+<p class="firstline">Returns the targetTcpProxies Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.targetVpnGateways.html">targetVpnGateways()</a></code>
+</p>
+<p class="firstline">Returns the targetVpnGateways Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.urlMaps.html">urlMaps()</a></code>
+</p>
+<p class="firstline">Returns the urlMaps Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.vpnTunnels.html">vpnTunnels()</a></code>
+</p>
+<p class="firstline">Returns the vpnTunnels Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.zoneOperations.html">zoneOperations()</a></code>
+</p>
+<p class="firstline">Returns the zoneOperations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_alpha.zones.html">zones()</a></code>
+</p>
+<p class="firstline">Returns the zones Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.httpHealthChecks.html b/docs/dyn/compute_alpha.httpHealthChecks.html
new file mode 100644
index 0000000..f780cf0
--- /dev/null
+++ b/docs/dyn/compute_alpha.httpHealthChecks.html
@@ -0,0 +1,510 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.httpHealthChecks.html">httpHealthChecks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, httpHealthCheck)</a></code></p>
+<p class="firstline">Deletes the specified HttpHealthCheck resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, httpHealthCheck)</a></code></p>
+<p class="firstline">Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a HttpHealthCheck resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of HttpHealthCheck 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, 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, httpHealthCheck, body)</a></code></p>
+<p class="firstline">Updates a HttpHealthCheck resource in the specified project using the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, httpHealthCheck)</code>
+ <pre>Deletes the specified HttpHealthCheck resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ httpHealthCheck: string, Name of the HttpHealthCheck resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, httpHealthCheck)</code>
+ <pre>Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
+ "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a HttpHealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
+ "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of HttpHealthCheck resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of HttpHealthCheck resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of HttpHealthCheck resources.
+ { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
+ "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#httpHealthCheckList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, 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, Project ID for 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 instances should be checked for health, via HTTP.
+ "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, httpHealthCheck, body)</code>
+ <pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for 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 instances should be checked for health, via HTTP.
+ "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.httpsHealthChecks.html b/docs/dyn/compute_alpha.httpsHealthChecks.html
new file mode 100644
index 0000000..c08250a
--- /dev/null
+++ b/docs/dyn/compute_alpha.httpsHealthChecks.html
@@ -0,0 +1,510 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.httpsHealthChecks.html">httpsHealthChecks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, httpsHealthCheck)</a></code></p>
+<p class="firstline">Deletes the specified HttpsHealthCheck resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, httpsHealthCheck)</a></code></p>
+<p class="firstline">Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a HttpsHealthCheck resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of HttpsHealthCheck 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, httpsHealthCheck, body)</a></code></p>
+<p class="firstline">Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, httpsHealthCheck, body)</a></code></p>
+<p class="firstline">Updates a HttpsHealthCheck resource in the specified project using the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, httpsHealthCheck)</code>
+ <pre>Deletes the specified HttpsHealthCheck resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ httpsHealthCheck: string, Name of the HttpsHealthCheck resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, httpsHealthCheck)</code>
+ <pre>Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ httpsHealthCheck: string, Name of the HttpsHealthCheck resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+ "kind": "compute#httpsHealthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+ "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 HTTPS health check request. The default value is 443.
+ "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+ "kind": "compute#httpsHealthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+ "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 HTTPS health check request. The default value is 443.
+ "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of HttpsHealthCheck resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of HttpsHealthCheck resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of HttpsHealthCheck resources.
+ { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+ "kind": "compute#httpsHealthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+ "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 HTTPS health check request. The default value is 443.
+ "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#httpsHealthCheckList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, httpsHealthCheck, body)</code>
+ <pre>Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+ "kind": "compute#httpsHealthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+ "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 HTTPS health check request. The default value is 443.
+ "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, httpsHealthCheck, body)</code>
+ <pre>Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+ "kind": "compute#httpsHealthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+ "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 HTTPS health check request. The default value is 443.
+ "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.images.html b/docs/dyn/compute_alpha.images.html
new file mode 100644
index 0000000..c568428
--- /dev/null
+++ b/docs/dyn/compute_alpha.images.html
@@ -0,0 +1,746 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.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.</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.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, image)</a></code></p>
+<p class="firstline">Returns the specified image. Get a list of available images by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#getFromFamily">getFromFamily(project, family)</a></code></p>
+<p class="firstline">Returns the latest image that is part of an image family and is not deprecated.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates an image in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.</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="#setLabels">setLabels(project, resource, body)</a></code></p>
+<p class="firstline">Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, image)</code>
+ <pre>Deletes the specified image.
+
+Args:
+ project: string, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="deprecate">deprecate(project, image, body)</code>
+ <pre>Sets the deprecation status of an image.
+
+If an empty request body is given, clears the deprecation status instead.
+
+Args:
+ project: string, Project ID for 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, image)</code>
+ <pre>Returns the specified image. Get a list of available images by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ image: string, Name of the image resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Image resource.
+ "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
+ # - zones/zone/disks/disk
+ "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
+ "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
+ "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an image.
+ "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
+ "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
+ "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
+ { # Guest OS features.
+ "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
+ },
+ ],
+ "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
+ "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
+ #
+ # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "rawDisk": { # The parameters of the raw disk image.
+ "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
+ "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
+ },
+ "licenses": [ # Any applicable license URI.
+ "A String",
+ ],
+ "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getFromFamily">getFromFamily(project, family)</code>
+ <pre>Returns the latest image that is part of an image family and is not deprecated.
+
+Args:
+ project: string, Project ID for this request. (required)
+ family: string, Name of the image family to search for. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Image resource.
+ "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
+ # - zones/zone/disks/disk
+ "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
+ "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
+ "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an image.
+ "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
+ "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
+ "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
+ { # Guest OS features.
+ "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
+ },
+ ],
+ "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
+ "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
+ #
+ # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "rawDisk": { # The parameters of the raw disk image.
+ "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
+ "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
+ },
+ "licenses": [ # Any applicable license URI.
+ "A String",
+ ],
+ "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates an image in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Image resource.
+ "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
+ # - zones/zone/disks/disk
+ "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
+ "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
+ "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an image.
+ "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
+ "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
+ "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
+ { # Guest OS features.
+ "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
+ },
+ ],
+ "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
+ "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
+ #
+ # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "rawDisk": { # The parameters of the raw disk image.
+ "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
+ "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
+ },
+ "licenses": [ # Any applicable license URI.
+ "A String",
+ ],
+ "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of images.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Image resources.
+ { # An Image resource.
+ "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
+ # - zones/zone/disks/disk
+ "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
+ "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
+ "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an image.
+ "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
+ "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
+ "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
+ { # Guest OS features.
+ "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
+ },
+ ],
+ "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
+ "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
+ #
+ # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "rawDisk": { # The parameters of the raw disk image.
+ "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
+ "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
+ },
+ "licenses": [ # Any applicable license URI.
+ "A String",
+ ],
+ "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#imageList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="setLabels">setLabels(project, resource, body)</code>
+ <pre>Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.
+ "labels": { # A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
+ "a_key": "A String",
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html
new file mode 100644
index 0000000..21847ff
--- /dev/null
+++ b/docs/dyn/compute_alpha.instanceGroupManagers.html
@@ -0,0 +1,1616 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.instanceGroupManagers.html">instanceGroupManagers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of managed instance groups and groups them by zone.</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, zone, instanceGroupManager)</a></code></p>
+<p class="firstline">Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.</p>
+<p class="toc_element">
+ <code><a href="#deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, zone, instanceGroupManager)</a></code></p>
+<p class="firstline">Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, zone, body)</a></code></p>
+<p class="firstline">Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of managed instance groups that are contained within the specified project and zone.</p>
+<p class="toc_element">
+ <code><a href="#listManagedInstances">listManagedInstances(project, zone, instanceGroupManager)</a></code></p>
+<p class="firstline">Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.</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, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#resize">resize(project, zone, instanceGroupManager, size)</a></code></p>
+<p class="firstline">Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#resizeAdvanced">resizeAdvanced(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.</p>
+<p class="toc_element">
+ <code><a href="#setAutoHealingPolicies">setAutoHealingPolicies(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Modifies the autohealing policies.</p>
+<p class="toc_element">
+ <code><a href="#setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.</p>
+<p class="toc_element">
+ <code><a href="#setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</code>
+ <pre>Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The URL for one or more instances to abandon from the managed instance group.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of managed instance groups and groups them by zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of filtered managed instance group lists.
+ "a_key": { # [Output Only] The name of the scope that contains this set of managed instance groups.
+ "warning": { # [Output Only] The warning that replaces the list of managed instance groups when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "instanceGroupManagers": [ # [Output Only] The list of managed instance groups that are contained in the specified project and zone.
+ { # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
+ {
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "instanceTemplate": "A String",
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
+ },
+ ],
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
+ },
+ "updatePolicy": { # The update policy for this managed instance group.
+ "type": "A String",
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
+ },
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ },
+ ],
+ },
+ },
+ "kind": "compute#instanceGroupManagerAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.
+ "id": "A String", # [Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
+ }</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, zone, instanceGroupManager)</code>
+ <pre>Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</code>
+ <pre>Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The list of instances to delete from this managed instance group. Specify one or more instance URLs.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, zone, instanceGroupManager)</code>
+ <pre>Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
+ {
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "instanceTemplate": "A String",
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
+ },
+ ],
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
+ },
+ "updatePolicy": { # The update policy for this managed instance group.
+ "type": "A String",
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
+ },
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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)</code>
+ <pre>Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where you want to create the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
+ {
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "instanceTemplate": "A String",
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
+ },
+ ],
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
+ },
+ "updatePolicy": { # The update policy for this managed instance group.
+ "type": "A String",
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
+ },
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of managed instance groups that are contained within the specified project and zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # [Output Only] A list of managed instance groups.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of managed instance groups.
+ { # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
+ {
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "instanceTemplate": "A String",
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
+ },
+ ],
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
+ },
+ "updatePolicy": { # The update policy for this managed instance group.
+ "type": "A String",
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
+ },
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ },
+ ],
+ "kind": "compute#instanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listManagedInstances">listManagedInstances(project, zone, instanceGroupManager)</code>
+ <pre>Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "managedInstances": [ # [Output Only] The list of instances in the managed instance group.
+ {
+ "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
+ "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
+ "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ },
+ "tag": "A String", # [Output Only] Tag describing the version.
+ "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
+ "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
+ "standbyMode": "A String", # [Output Only] Standby mode of the instance. This field is non-empty iff the instance is a standby.
+ "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
+ # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
+ # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
+ # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
+ # - RECREATING The managed instance group is recreating this instance.
+ # - DELETING The managed instance group is permanently deleting this instance.
+ # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
+ # - RESTARTING The managed instance group is restarting the instance.
+ # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
+ "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
+ },
+ ],
+ }</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, zone, instanceGroupManager, body)</code>
+ <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where you want to create the managed instance group. (required)
+ instanceGroupManager: string, The name of the instance group manager. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
+ {
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "instanceTemplate": "A String",
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
+ },
+ ],
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
+ },
+ "updatePolicy": { # The update policy for this managed instance group.
+ "type": "A String",
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
+ },
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</code>
+ <pre>Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The URL for one or more instances to recreate.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resize">resize(project, zone, instanceGroupManager, size)</code>
+ <pre>Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ size: integer, The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resizeAdvanced">resizeAdvanced(project, zone, instanceGroupManager, body)</code>
+ <pre>Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.
+
+If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "noCreationRetries": True or False, # If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attemps to recreate each instance continuously until it succeeds.
+ #
+ # This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario.
+ #
+ # This flag is applicable only to the current resize request. It does not influence other resize requests in any way.
+ #
+ # You can see which instances is being creating in which mode by calling the get or listManagedInstances API.
+ "targetSize": 42, # The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, zone, instanceGroupManager, body)</code>
+ <pre>Modifies the autohealing policies.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the instance group manager. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "autoHealingPolicies": [
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</code>
+ <pre>Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</code>
+ <pre>Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "targetPools": [ # The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.
+ "A String",
+ ],
+ "fingerprint": "A String", # The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, zone, instanceGroupManager, body)</code>
+ <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where you want to create the managed instance group. (required)
+ instanceGroupManager: string, The name of the instance group manager. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
+ {
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "instanceTemplate": "A String",
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
+ },
+ ],
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
+ },
+ "updatePolicy": { # The update policy for this managed instance group.
+ "type": "A String",
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
+ },
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.instanceGroups.html b/docs/dyn/compute_alpha.instanceGroups.html
new file mode 100644
index 0000000..076c149
--- /dev/null
+++ b/docs/dyn/compute_alpha.instanceGroups.html
@@ -0,0 +1,773 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.instanceGroups.html">instanceGroups</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#addInstances">addInstances(project, zone, instanceGroup, body)</a></code></p>
+<p class="firstline">Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.</p>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of instance groups and sorts them by zone.</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, zone, instanceGroup)</a></code></p>
+<p class="firstline">Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, zone, instanceGroup)</a></code></p>
+<p class="firstline">Returns the specified instance group. Get a list of available instance groups by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, zone, body)</a></code></p>
+<p class="firstline">Creates an instance group in the specified project using the parameters that are included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of instance groups that are located in the specified project and zone.</p>
+<p class="toc_element">
+ <code><a href="#listInstances">listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Lists the instances in the specified instance group.</p>
+<p class="toc_element">
+ <code><a href="#listInstances_next">listInstances_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="#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="#removeInstances">removeInstances(project, zone, instanceGroup, body)</a></code></p>
+<p class="firstline">Removes one or more instances from the specified instance group, but does not delete those instances.</p>
+<p class="toc_element">
+ <code><a href="#setNamedPorts">setNamedPorts(project, zone, instanceGroup, body)</a></code></p>
+<p class="firstline">Sets the named ports for the specified instance group.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="addInstances">addInstances(project, zone, instanceGroup, body)</code>
+ <pre>Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ instanceGroup: string, The name of the instance group where you are adding instances. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The list of instances to add to the instance group.
+ {
+ "instance": "A String", # The URL for a specific instance.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of instance groups and sorts them by zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # A map of scoped instance group lists.
+ "a_key": { # The name of the scope that contains this set of instance groups.
+ "warning": { # [Output Only] An informational warning that replaces the list of instance groups when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "instanceGroups": [ # [Output Only] The list of instance groups that are contained in this scope.
+ {
+ "size": 42, # [Output Only] The total number of instances in the instance group.
+ "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
+ "network": "A String", # The URL of the network to which all instances in the instance group belong.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+ "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+ "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+ #
+ # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+ #
+ # Named ports apply to all instances in this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
+ "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
+ "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ },
+ ],
+ },
+ },
+ "kind": "compute#instanceGroupAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.
+ "id": "A String", # [Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
+ }</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, zone, instanceGroup)</code>
+ <pre>Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ instanceGroup: string, The name of the instance group to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, zone, instanceGroup)</code>
+ <pre>Returns the specified instance group. Get a list of available instance groups by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ instanceGroup: string, The name of the instance group. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "size": 42, # [Output Only] The total number of instances in the instance group.
+ "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
+ "network": "A String", # The URL of the network to which all instances in the instance group belong.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+ "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+ "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+ #
+ # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+ #
+ # Named ports apply to all instances in this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
+ "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
+ "name": "A String", # The name of the instance group. 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)</code>
+ <pre>Creates an instance group in the specified project using the parameters that are included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where you want to create the instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "size": 42, # [Output Only] The total number of instances in the instance group.
+ "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
+ "network": "A String", # The URL of the network to which all instances in the instance group belong.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+ "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+ "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+ #
+ # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+ #
+ # Named ports apply to all instances in this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
+ "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
+ "name": "A String", # The name of the instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of instance groups that are located in the specified project and zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # A list of InstanceGroup resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of instance groups.
+ {
+ "size": 42, # [Output Only] The total number of instances in the instance group.
+ "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
+ "network": "A String", # The URL of the network to which all instances in the instance group belong.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+ "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+ "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+ #
+ # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+ #
+ # Named ports apply to all instances in this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
+ "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
+ "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ },
+ ],
+ "kind": "compute#instanceGroupList", # [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.
+ "id": "A String", # [Output Only] A unique identifier for this list of instance groups. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listInstances">listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Lists the instances in the specified instance group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ instanceGroup: string, The name of the instance group from which you want to generate a list of included instances. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instanceState": "A String", # A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.
+ }
+
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of instances and any named ports that are assigned to those instances.
+ {
+ "status": "A String", # [Output Only] The status of the instance.
+ "instance": "A String", # [Output Only] The URL of the instance.
+ "namedPorts": [ # [Output Only] The named ports that belong to this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ },
+ ],
+ "kind": "compute#instanceGroupsListInstances", # [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.
+ "id": "A String", # [Output Only] A unique identifier for this list of instances in the specified instance group. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this list of instances in the specified instance groups. The server generates this URL.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listInstances_next">listInstances_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="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="removeInstances">removeInstances(project, zone, instanceGroup, body)</code>
+ <pre>Removes one or more instances from the specified instance group, but does not delete those instances.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ instanceGroup: string, The name of the instance group where the specified instances will be removed. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The list of instances to remove from the instance group.
+ {
+ "instance": "A String", # The URL for a specific instance.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setNamedPorts">setNamedPorts(project, zone, instanceGroup, body)</code>
+ <pre>Sets the named ports for the specified instance group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ instanceGroup: string, The name of the instance group where the named ports are updated. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "namedPorts": [ # The list of named ports to set for this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html
new file mode 100644
index 0000000..f33d6eb
--- /dev/null
+++ b/docs/dyn/compute_alpha.instanceTemplates.html
@@ -0,0 +1,809 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.instanceTemplates.html">instanceTemplates</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, instanceTemplate)</a></code></p>
+<p class="firstline">Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, instanceTemplate)</a></code></p>
+<p class="firstline">Returns the specified instance template. Get a list of available instance templates by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of instance templates that are contained within the specified project and 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, instanceTemplate)</code>
+ <pre>Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ instanceTemplate: string, The name of the instance template to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, instanceTemplate)</code>
+ <pre>Returns the specified instance template. Get a list of available instance templates by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ instanceTemplate: string, The name of the instance template. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Instance Template resource.
+ "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
+ "sourceInstance": "A String", # The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
+ "properties": { # The instance properties for this instance template.
+ "disks": [ # An array of disks that are associated with the instances that are created from this template.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "machineType": "A String", # The machine type to use for instances that are created from this template.
+ "description": "A String", # An optional text description for the instances that are created from this instance template.
+ "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labels": { # Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
+ "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "networkInterfaces": [ # An array of network access configurations for this interface.
+ { # A network interface resource attached to an instance.
+ "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
+ { # An alias IP range attached to an instance's network interface.
+ "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
+ "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
+ },
+ ],
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "name": "A String", # Name of this access configuration.
+ "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
+ "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ },
+ "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Instance Template resource.
+ "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
+ "sourceInstance": "A String", # The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
+ "properties": { # The instance properties for this instance template.
+ "disks": [ # An array of disks that are associated with the instances that are created from this template.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "machineType": "A String", # The machine type to use for instances that are created from this template.
+ "description": "A String", # An optional text description for the instances that are created from this instance template.
+ "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labels": { # Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
+ "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "networkInterfaces": [ # An array of network access configurations for this interface.
+ { # A network interface resource attached to an instance.
+ "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
+ { # An alias IP range attached to an instance's network interface.
+ "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
+ "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
+ },
+ ],
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "name": "A String", # Name of this access configuration.
+ "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
+ "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ },
+ "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of instance templates that are contained within the specified project and zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # A list of instance templates.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] list of InstanceTemplate resources.
+ { # An Instance Template resource.
+ "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
+ "sourceInstance": "A String", # The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
+ "properties": { # The instance properties for this instance template.
+ "disks": [ # An array of disks that are associated with the instances that are created from this template.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "machineType": "A String", # The machine type to use for instances that are created from this template.
+ "description": "A String", # An optional text description for the instances that are created from this instance template.
+ "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labels": { # Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
+ "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "networkInterfaces": [ # An array of network access configurations for this interface.
+ { # A network interface resource attached to an instance.
+ "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
+ { # An alias IP range attached to an instance's network interface.
+ "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
+ "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
+ },
+ ],
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "name": "A String", # Name of this access configuration.
+ "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
+ "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ },
+ "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#instanceTemplateList", # [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.
+ "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this instance template list. The server defines this URL.
+ }</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="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html
new file mode 100644
index 0000000..4359b5b
--- /dev/null
+++ b/docs/dyn/compute_alpha.instances.html
@@ -0,0 +1,2778 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.instances.html">instances</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</a></code></p>
+<p class="firstline">Adds an access config to an instance's network interface.</p>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves aggregated list of instances.</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="#attachDisk">attachDisk(project, zone, instance, body, forceAttach=None)</a></code></p>
+<p class="firstline">Attaches a Disk resource to an instance.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, zone, instance)</a></code></p>
+<p class="firstline">Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.</p>
+<p class="toc_element">
+ <code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</a></code></p>
+<p class="firstline">Deletes an access config from an instance's network interface.</p>
+<p class="toc_element">
+ <code><a href="#detachDisk">detachDisk(project, zone, instance, deviceName)</a></code></p>
+<p class="firstline">Detaches a disk from an instance.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, zone, instance)</a></code></p>
+<p class="firstline">Returns the specified Instance resource. Get a list of available instances by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource)</a></code></p>
+<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
+<p class="toc_element">
+ <code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, start=None, port=None)</a></code></p>
+<p class="firstline">Returns the specified instance's serial port output.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, zone, body)</a></code></p>
+<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of instances 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>
+<p class="toc_element">
+ <code><a href="#reset">reset(project, zone, instance)</a></code></p>
+<p class="firstline">Performs a hard reset on the instance.</p>
+<p class="toc_element">
+ <code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</a></code></p>
+<p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body)</a></code></p>
+<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
+<p class="toc_element">
+ <code><a href="#setLabels">setLabels(project, zone, instance, body)</a></code></p>
+<p class="firstline">Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.</p>
+<p class="toc_element">
+ <code><a href="#setMachineType">setMachineType(project, zone, instance, body)</a></code></p>
+<p class="firstline">Changes the machine type for a stopped instance to the machine type specified in the request.</p>
+<p class="toc_element">
+ <code><a href="#setMetadata">setMetadata(project, zone, instance, body)</a></code></p>
+<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#setScheduling">setScheduling(project, zone, instance, body)</a></code></p>
+<p class="firstline">Sets an instance's scheduling options.</p>
+<p class="toc_element">
+ <code><a href="#setServiceAccount">setServiceAccount(project, zone, instance, body)</a></code></p>
+<p class="firstline">Sets the service account on the instance.</p>
+<p class="toc_element">
+ <code><a href="#setTags">setTags(project, zone, instance, body)</a></code></p>
+<p class="firstline">Sets tags for the specified instance to the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#start">start(project, zone, instance)</a></code></p>
+<p class="firstline">Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.</p>
+<p class="toc_element">
+ <code><a href="#startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body)</a></code></p>
+<p class="firstline">Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.</p>
+<p class="toc_element">
+ <code><a href="#stop">stop(project, zone, instance, discardLocalSsd=None)</a></code></p>
+<p class="firstline">Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.</p>
+<p class="toc_element">
+ <code><a href="#suspend">suspend(project, zone, instance, discardLocalSsd=None)</a></code></p>
+<p class="firstline">This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body)</a></code></p>
+<p class="firstline">Updates the specified access config from an instance's network interface with the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</code>
+ <pre>Adds an access config to an instance's network interface.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name for this request. (required)
+ networkInterface: string, The name of the network interface to add to this instance. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "name": "A String", # Name of this access configuration.
+ "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
+ "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves aggregated list of instances.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped instance lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of instances.
+ "instances": [ # [Output Only] List of instances contained in this scope.
+ { # An Instance resource.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
+ "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
+ #
+ # zones/us-central1-f/machineTypes/n1-standard-1
+ #
+ # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
+ #
+ # zones/zone/machineTypes/custom-CPUS-MEMORY
+ #
+ # For example: zones/us-central1-f/machineTypes/custom-4-5120
+ #
+ # For a full list of restrictions, read the Specifications for custom machine types.
+ "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
+ { # A network interface resource attached to an instance.
+ "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
+ { # An alias IP range attached to an instance's network interface.
+ "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
+ "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
+ },
+ ],
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "name": "A String", # Name of this access configuration.
+ "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
+ "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "zone": "A String", # [Output Only] URL of the zone where the instance resides.
+ "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
+ #
+ # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
+ #
+ # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.
+ #
+ # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
+ "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ "host": "A String", # Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host.
+ #
+ # Optional, Private Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same private host.
+ #
+ # The request will be rejected if the private host has run out of resources.
+ "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ },
+ ],
+ "warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="attachDisk">attachDisk(project, zone, instance, body, forceAttach=None)</code>
+ <pre>Attaches a Disk resource to an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+}
+
+ forceAttach: boolean, Whether to force attach the disk even if it's currently attached to another instance. This is only available for regional disks.
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, zone, instance)</code>
+ <pre>Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</code>
+ <pre>Deletes an access config from an instance's network interface.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name for this request. (required)
+ accessConfig: string, The name of the access config to delete. (required)
+ networkInterface: string, The name of the network interface. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName)</code>
+ <pre>Detaches a disk from an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Instance name. (required)
+ deviceName: string, Disk device name to detach. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, zone, instance)</code>
+ <pre>Returns the specified Instance resource. Get a list of available instances by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Instance resource.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
+ "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
+ #
+ # zones/us-central1-f/machineTypes/n1-standard-1
+ #
+ # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
+ #
+ # zones/zone/machineTypes/custom-CPUS-MEMORY
+ #
+ # For example: zones/us-central1-f/machineTypes/custom-4-5120
+ #
+ # For a full list of restrictions, read the Specifications for custom machine types.
+ "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
+ { # A network interface resource attached to an instance.
+ "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
+ { # An alias IP range attached to an instance's network interface.
+ "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
+ "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
+ },
+ ],
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "name": "A String", # Name of this access configuration.
+ "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
+ "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "zone": "A String", # [Output Only] URL of the zone where the instance resides.
+ "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
+ #
+ # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
+ #
+ # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.
+ #
+ # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
+ "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ "host": "A String", # Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host.
+ #
+ # Optional, Private Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same private host.
+ #
+ # The request will be rejected if the private host has run out of resources.
+ "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource)</code>
+ <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, start=None, port=None)</code>
+ <pre>Returns the specified instance's serial port output.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance scoping this request. (required)
+ start: string, For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value that was returned in the previous call.
+ port: integer, Specifies which COM or serial port to retrieve data from.
+
+Returns:
+ An object of the form:
+
+ { # An instance's serial console output.
+ "start": "A String", # [Output Only] The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched.
+ "kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ "contents": "A String", # [Output Only] The contents of the console output.
+ "next": "A String", # [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, zone, body)</code>
+ <pre>Creates an instance resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Instance resource.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
+ "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
+ #
+ # zones/us-central1-f/machineTypes/n1-standard-1
+ #
+ # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
+ #
+ # zones/zone/machineTypes/custom-CPUS-MEMORY
+ #
+ # For example: zones/us-central1-f/machineTypes/custom-4-5120
+ #
+ # For a full list of restrictions, read the Specifications for custom machine types.
+ "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
+ { # A network interface resource attached to an instance.
+ "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
+ { # An alias IP range attached to an instance's network interface.
+ "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
+ "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
+ },
+ ],
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "name": "A String", # Name of this access configuration.
+ "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
+ "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "zone": "A String", # [Output Only] URL of the zone where the instance resides.
+ "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
+ #
+ # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
+ #
+ # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.
+ #
+ # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
+ "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ "host": "A String", # Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host.
+ #
+ # Optional, Private Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same private host.
+ #
+ # The request will be rejected if the private host has run out of resources.
+ "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of instances contained within the specified zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of instances.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of instances.
+ { # An Instance resource.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
+ "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
+ #
+ # zones/us-central1-f/machineTypes/n1-standard-1
+ #
+ # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
+ #
+ # zones/zone/machineTypes/custom-CPUS-MEMORY
+ #
+ # For example: zones/us-central1-f/machineTypes/custom-4-5120
+ #
+ # For a full list of restrictions, read the Specifications for custom machine types.
+ "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
+ { # A network interface resource attached to an instance.
+ "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
+ { # An alias IP range attached to an instance's network interface.
+ "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
+ "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
+ },
+ ],
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "name": "A String", # Name of this access configuration.
+ "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
+ "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "zone": "A String", # [Output Only] URL of the zone where the instance resides.
+ "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
+ #
+ # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
+ #
+ # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.
+ #
+ # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
+ "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ "host": "A String", # Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host.
+ #
+ # Optional, Private Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same private host.
+ #
+ # The request will be rejected if the private host has run out of resources.
+ "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ },
+ ],
+ "kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="reset">reset(project, zone, instance)</code>
+ <pre>Performs a hard reset on the instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance scoping this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</code>
+ <pre>Sets the auto-delete flag for a disk attached to an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name. (required)
+ autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
+ deviceName: string, The device name of the disk to modify. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body)</code>
+ <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setLabels">setLabels(project, zone, instance, body)</code>
+ <pre>Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance scoping this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "labelFingerprint": "A String", # Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.
+ "labels": { # A list of labels to apply for this instance. Changing instance labels will also change the instance tags.
+ #
+ # Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
+ "a_key": "A String",
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setMachineType">setMachineType(project, zone, instance, body)</code>
+ <pre>Changes the machine type for a stopped instance to the machine type specified in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance scoping this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "machineType": "A String", # Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setMetadata">setMetadata(project, zone, instance, body)</code>
+ <pre>Sets metadata for the specified instance to the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setScheduling">setScheduling(project, zone, instance, body)</code>
+ <pre>Sets an instance's scheduling options.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Instance name. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Sets the scheduling options for an Instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setServiceAccount">setServiceAccount(project, zone, instance, body)</code>
+ <pre>Sets the service account on the instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance resource to start. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setTags">setTags(project, zone, instance, body)</code>
+ <pre>Sets tags for the specified instance to the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance scoping this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A set of instance tags.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="start">start(project, zone, instance)</code>
+ <pre>Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance resource to start. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body)</code>
+ <pre>Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance resource to start. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.
+ #
+ # If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance start will not succeed.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.
+ #
+ # In order to start the instance, the disk url and its corresponding key must be provided.
+ #
+ # If the disk is not protected with a customer-supplied encryption key it should not be specified.
+ {
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with the disk with a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="stop">stop(project, zone, instance, discardLocalSsd=None)</code>
+ <pre>Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance resource to stop. (required)
+ discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false.
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None)</code>
+ <pre>This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance resource to suspend. (required)
+ discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false.
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body)</code>
+ <pre>Updates the specified access config from an instance's network interface with the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name for this request. (required)
+ networkInterface: string, The name of the network interface where the access config is attached. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "name": "A String", # Name of this access configuration.
+ "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM.
+ "ptrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_ptr field is enabled.
+ "dnsName": "A String", # [Output Only] The public DNS domain name for the instance.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ "setPtr": True or False, # Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.licenses.html b/docs/dyn/compute_alpha.licenses.html
new file mode 100644
index 0000000..6bce5b6
--- /dev/null
+++ b/docs/dyn/compute_alpha.licenses.html
@@ -0,0 +1,100 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.licenses.html">licenses</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(project, license)</a></code></p>
+<p class="firstline">Returns the specified License resource. Get a list of available licenses by making a list() request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(project, license)</code>
+ <pre>Returns the specified License resource. Get a list of available licenses by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ license: string, Name of the License resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A license resource.
+ "chargesUseFee": True or False, # [Output Only] If true, the customer will be charged license fee for running software that contains this license on an instance.
+ "kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses.
+ "name": "A String", # [Output Only] Name of the resource. The name is 1-63 characters long and complies with RFC1035.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.machineTypes.html b/docs/dyn/compute_alpha.machineTypes.html
new file mode 100644
index 0000000..4fdc60e
--- /dev/null
+++ b/docs/dyn/compute_alpha.machineTypes.html
@@ -0,0 +1,286 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.machineTypes.html">machineTypes</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of machine types.</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. Get a list of available machine types by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of machine types 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, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of machine types.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped machine type lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of machine types.
+ "machineTypes": [ # [Output Only] List of machine types contained in this scope.
+ { # A Machine Type resource.
+ "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
+ "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
+ "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
+ "description": "A String", # [Output Only] An optional textual description of the resource.
+ "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
+ "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
+ "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ "warning": { # [Output Only] An informational warning that appears when the machine types list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#machineTypeAggregatedList", # [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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. Get a list of available machine types by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ machineType: string, Name of the machine type to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Machine Type resource.
+ "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
+ "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
+ "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
+ "description": "A String", # [Output Only] An optional textual description of the resource.
+ "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
+ "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
+ "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of machine types available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of machine types.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Machine Type resources.
+ { # A Machine Type resource.
+ "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
+ "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
+ "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
+ "description": "A String", # [Output Only] An optional textual description of the resource.
+ "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
+ "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
+ "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ "kind": "compute#machineTypeList", # [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.networks.html b/docs/dyn/compute_alpha.networks.html
new file mode 100644
index 0000000..86c9db0
--- /dev/null
+++ b/docs/dyn/compute_alpha.networks.html
@@ -0,0 +1,420 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.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.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, network)</a></code></p>
+<p class="firstline">Returns the specified network. Get a list of available networks by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a network in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of networks 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="#switchToCustomMode">switchToCustomMode(project, network)</a></code></p>
+<p class="firstline">Switches the network mode from auto subnet mode to custom subnet mode.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, network)</code>
+ <pre>Deletes the specified network.
+
+Args:
+ project: string, Project ID for this request. (required)
+ network: string, Name of the network to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, network)</code>
+ <pre>Returns the specified network. Get a list of available networks by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ network: string, Name of the network to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents a Network resource. Read Networks and Firewalls for more information.
+ "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "loadBalancerVmEncryption": "A String", # [Output Only] Type of LB-to-VM traffic encryption for this network.
+ "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
+ "A String",
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
+ #
+ # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "crossVmEncryption": "A String", # [Output Only] Type of VM-to-VM traffic encryption for this network.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a network in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Network resource. Read Networks and Firewalls for more information.
+ "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "loadBalancerVmEncryption": "A String", # [Output Only] Type of LB-to-VM traffic encryption for this network.
+ "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
+ "A String",
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
+ #
+ # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "crossVmEncryption": "A String", # [Output Only] Type of VM-to-VM traffic encryption for this network.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of networks available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of networks.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Network resources.
+ { # Represents a Network resource. Read Networks and Firewalls for more information.
+ "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "loadBalancerVmEncryption": "A String", # [Output Only] Type of LB-to-VM traffic encryption for this network.
+ "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
+ "A String",
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
+ #
+ # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "crossVmEncryption": "A String", # [Output Only] Type of VM-to-VM traffic encryption for this network.
+ },
+ ],
+ "kind": "compute#networkList", # [Output Only] Type of resource. Always compute#networkList for lists of networks.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="switchToCustomMode">switchToCustomMode(project, network)</code>
+ <pre>Switches the network mode from auto subnet mode to custom subnet mode.
+
+Args:
+ project: string, Project ID for this request. (required)
+ network: string, Name of the network to be updated. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.projects.html b/docs/dyn/compute_alpha.projects.html
new file mode 100644
index 0000000..a7080a9
--- /dev/null
+++ b/docs/dyn/compute_alpha.projects.html
@@ -0,0 +1,881 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.projects.html">projects</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#disableXpnHost">disableXpnHost(project)</a></code></p>
+<p class="firstline">Disable this project as an XPN host project.</p>
+<p class="toc_element">
+ <code><a href="#disableXpnResource">disableXpnResource(project, body)</a></code></p>
+<p class="firstline">Disable an XPN resource associated with this host project.</p>
+<p class="toc_element">
+ <code><a href="#enableXpnHost">enableXpnHost(project)</a></code></p>
+<p class="firstline">Enable this project as an XPN host project.</p>
+<p class="toc_element">
+ <code><a href="#enableXpnResource">enableXpnResource(project, body)</a></code></p>
+<p class="firstline">Enable XPN resource (a.k.a service project or service folder in the future) for a host project, so that subnetworks in the host project can be used by instances in the service project or folder.</p>
+<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="#getXpnHost">getXpnHost(project)</a></code></p>
+<p class="firstline">Get the XPN host project that this project links to. May be empty if no link exists.</p>
+<p class="toc_element">
+ <code><a href="#getXpnResources">getXpnResources(project)</a></code></p>
+<p class="firstline">Get XPN resources associated with this host project.</p>
+<p class="toc_element">
+ <code><a href="#listXpnHosts">listXpnHosts(project, body)</a></code></p>
+<p class="firstline">List all XPN host projects visible to the user in an organization.</p>
+<p class="toc_element">
+ <code><a href="#moveDisk">moveDisk(project, body)</a></code></p>
+<p class="firstline">Moves a persistent disk from one zone to another.</p>
+<p class="toc_element">
+ <code><a href="#moveInstance">moveInstance(project, body)</a></code></p>
+<p class="firstline">Moves an instance and its attached persistent disks from one zone to another.</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>
+<p class="toc_element">
+ <code><a href="#setDefaultServiceAccount">setDefaultServiceAccount(project, body)</a></code></p>
+<p class="firstline">Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default".</p>
+<p class="toc_element">
+ <code><a href="#setUsageExportBucket">setUsageExportBucket(project, body)</a></code></p>
+<p class="firstline">Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="disableXpnHost">disableXpnHost(project)</code>
+ <pre>Disable this project as an XPN host project.
+
+Args:
+ project: string, Project ID for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="disableXpnResource">disableXpnResource(project, body)</code>
+ <pre>Disable an XPN resource associated with this host project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "xpnResource": { # XpnResourceId # XPN resource ID.
+ "type": "A String", # The type of the XPN resource.
+ "id": "A String", # The ID of the XPN resource. In the case of projects, this field matches the project's name, not the canonical ID.
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="enableXpnHost">enableXpnHost(project)</code>
+ <pre>Enable this project as an XPN host project.
+
+Args:
+ project: string, Project ID for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="enableXpnResource">enableXpnResource(project, body)</code>
+ <pre>Enable XPN resource (a.k.a service project or service folder in the future) for a host project, so that subnetworks in the host project can be used by instances in the service project or folder.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "xpnResource": { # XpnResourceId # XPN resource ID.
+ "type": "A String", # The type of the XPN resource.
+ "id": "A String", # The ID of the XPN resource. In the case of projects, this field matches the project's name, not the canonical ID.
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project)</code>
+ <pre>Returns the specified Project resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
+ "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
+ "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
+ "enabledFeatures": [ # Restricted features enabled for use on this project.
+ "A String",
+ ],
+ "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ "quotas": [ # [Output Only] Quotas assigned to this project.
+ { # A quotas entry.
+ "usage": 3.14, # [Output Only] Current usage of this metric.
+ "metric": "A String", # [Output Only] Name of the quota metric.
+ "limit": 3.14, # [Output Only] Quota limit for this metric.
+ },
+ ],
+ "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
+ "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
+ "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
+ "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
+ },
+ "xpnProjectStatus": "A String", # [Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "description": "A String", # An optional textual description of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getXpnHost">getXpnHost(project)</code>
+ <pre>Get the XPN host project that this project links to. May be empty if no link exists.
+
+Args:
+ project: string, Project ID for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
+ "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
+ "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
+ "enabledFeatures": [ # Restricted features enabled for use on this project.
+ "A String",
+ ],
+ "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ "quotas": [ # [Output Only] Quotas assigned to this project.
+ { # A quotas entry.
+ "usage": 3.14, # [Output Only] Current usage of this metric.
+ "metric": "A String", # [Output Only] Name of the quota metric.
+ "limit": 3.14, # [Output Only] Quota limit for this metric.
+ },
+ ],
+ "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
+ "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
+ "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
+ "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
+ },
+ "xpnProjectStatus": "A String", # [Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "description": "A String", # An optional textual description of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getXpnResources">getXpnResources(project)</code>
+ <pre>Get XPN resources associated with this host project.
+
+Args:
+ project: string, Project ID for this request. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "compute#projectsGetXpnResources", # [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of XPN resources.
+ "resources": [ # XPN resources attached to this project as their XPN host.
+ { # XpnResourceId
+ "type": "A String", # The type of the XPN resource.
+ "id": "A String", # The ID of the XPN resource. In the case of projects, this field matches the project's name, not the canonical ID.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listXpnHosts">listXpnHosts(project, body)</code>
+ <pre>List all XPN host projects visible to the user in an organization.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "organization": "A String", # Optional organization ID managed by Cloud Resource Manager, for which to list XPN host projects. If not specified, the organization will be inferred from the project.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of XPN host project URLs.
+ { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
+ "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
+ "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
+ "enabledFeatures": [ # Restricted features enabled for use on this project.
+ "A String",
+ ],
+ "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ "quotas": [ # [Output Only] Quotas assigned to this project.
+ { # A quotas entry.
+ "usage": 3.14, # [Output Only] Current usage of this metric.
+ "metric": "A String", # [Output Only] Name of the quota metric.
+ "limit": 3.14, # [Output Only] Quota limit for this metric.
+ },
+ ],
+ "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
+ "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
+ "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
+ "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
+ },
+ "xpnProjectStatus": "A String", # [Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "description": "A String", # An optional textual description of the resource.
+ },
+ ],
+ "kind": "compute#xpnHostList", # [Output Only] Type of resource. Always compute#xpnHostList for lists of XPN hosts.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="moveDisk">moveDisk(project, body)</code>
+ <pre>Moves a persistent disk from one zone to another.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "targetDisk": "A String", # The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
+ # - zones/zone/disks/disk
+ "destinationZone": "A String", # The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
+ # - projects/project/zones/zone
+ # - zones/zone
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="moveInstance">moveInstance(project, body)</code>
+ <pre>Moves an instance and its attached persistent disks from one zone to another.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "targetInstance": "A String", # The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ # - zones/zone/instances/instance
+ "destinationZone": "A String", # The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
+ # - projects/project/zones/zone
+ # - zones/zone
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</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, Project ID for 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setDefaultServiceAccount">setDefaultServiceAccount(project, body)</code>
+ <pre>Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default".
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "email": "A String", # Email address of the service account.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setUsageExportBucket">setUsageExportBucket(project, body)</code>
+ <pre>Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.
+ "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
+ "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.regionAutoscalers.html b/docs/dyn/compute_alpha.regionAutoscalers.html
new file mode 100644
index 0000000..e50baf9
--- /dev/null
+++ b/docs/dyn/compute_alpha.regionAutoscalers.html
@@ -0,0 +1,727 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionAutoscalers.html">regionAutoscalers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, region, autoscaler)</a></code></p>
+<p class="firstline">Deletes the specified autoscaler.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, autoscaler)</a></code></p>
+<p class="firstline">Returns the specified autoscaler.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates an autoscaler in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of autoscalers 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>
+<p class="toc_element">
+ <code><a href="#patch">patch(project, region, autoscaler, body)</a></code></p>
+<p class="firstline">Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, region, body, autoscaler=None)</a></code></p>
+<p class="firstline">Updates an autoscaler in the specified project using the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, region, autoscaler)</code>
+ <pre>Deletes the specified autoscaler.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ autoscaler: string, Name of the autoscaler to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, autoscaler)</code>
+ <pre>Returns the specified autoscaler.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ autoscaler: string, Name of the autoscaler to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
+ "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
+ "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
+ "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
+ "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
+ "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
+ },
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates an autoscaler in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for 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:
+
+{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
+ "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
+ "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
+ "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
+ "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
+ "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
+ },
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of autoscalers contained within the specified region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of autoscalers.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # A list of autoscalers.
+ { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
+ "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
+ "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
+ "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
+ "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
+ "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
+ },
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#regionAutoscalerList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, region, autoscaler, body)</code>
+ <pre>Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ autoscaler: string, Name of the autoscaler to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
+ "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
+ "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
+ "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
+ "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
+ "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
+ },
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, region, body, autoscaler=None)</code>
+ <pre>Updates an autoscaler in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for 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:
+
+{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "queueBasedScaling": { # Configuration parameters of autoscaling based on queuing system. # Configuration parameters of autoscaling based on queuing system.
+ "acceptableBacklogPerInstance": 3.14, # Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
+ "singleWorkerThroughputPerSec": 3.14, # The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
+ "cloudPubSub": { # Configuration parameters for scaling based on Cloud Pub/Sub subscription queue. # Configuration for Cloud Pub/Sub subscription queue.
+ "topic": "A String", # Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
+ "subscription": "A String", # Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
+ },
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+ autoscaler: string, Name of the autoscaler to update.
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html
new file mode 100644
index 0000000..29aa718
--- /dev/null
+++ b/docs/dyn/compute_alpha.regionBackendServices.html
@@ -0,0 +1,972 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionBackendServices.html">regionBackendServices</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, region, backendService)</a></code></p>
+<p class="firstline">Deletes the specified regional BackendService resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, backendService)</a></code></p>
+<p class="firstline">Returns the specified regional BackendService resource.</p>
+<p class="toc_element">
+ <code><a href="#getHealth">getHealth(project, region, backendService, body)</a></code></p>
+<p class="firstline">Gets the most recent health check results for this regional BackendService.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of regional BackendService resources available to the specified project in the given 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>
+<p class="toc_element">
+ <code><a href="#patch">patch(project, region, backendService, body)</a></code></p>
+<p class="firstline">Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, region, backendService, body)</a></code></p>
+<p class="firstline">Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, region, backendService)</code>
+ <pre>Deletes the specified regional BackendService resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ backendService: string, Name of the BackendService resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, backendService)</code>
+ <pre>Returns the specified regional BackendService resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ backendService: string, Name of the BackendService resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
+ "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
+ "A String",
+ ],
+ },
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "loadBalancingScheme": "A String",
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
+ "oauth2ClientId": "A String",
+ "enabled": True or False,
+ "oauth2ClientSecret": "A String",
+ "oauth2ClientSecretSha256": "A String",
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ },
+ },
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getHealth">getHealth(project, region, backendService, body)</code>
+ <pre>Gets the most recent health check results for this regional BackendService.
+
+Args:
+ project: string, A parameter (required)
+ region: string, Name of the region scoping this request. (required)
+ backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "group": "A String", # A URI referencing one of the instance groups listed in the backend service.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
+ "healthStatus": [
+ {
+ "instance": "A String", # URL of the instance resource.
+ "healthState": "A String", # Health state of the instance.
+ "ipAddress": "A String", # The IP address represented by this resource.
+ "port": 42, # The port on the instance.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.
+
+Args:
+ project: string, Project ID for 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 BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
+ "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
+ "A String",
+ ],
+ },
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "loadBalancingScheme": "A String",
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
+ "oauth2ClientId": "A String",
+ "enabled": True or False,
+ "oauth2ClientSecret": "A String",
+ "oauth2ClientSecretSha256": "A String",
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ },
+ },
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of regional BackendService resources available to the specified project in the given region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of BackendService resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # A list of BackendService resources.
+ { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
+ "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
+ "A String",
+ ],
+ },
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "loadBalancingScheme": "A String",
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
+ "oauth2ClientId": "A String",
+ "enabled": True or False,
+ "oauth2ClientSecret": "A String",
+ "oauth2ClientSecretSha256": "A String",
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ },
+ },
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ },
+ ],
+ "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, region, backendService, body)</code>
+ <pre>Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ backendService: string, Name of the BackendService resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
+ "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
+ "A String",
+ ],
+ },
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "loadBalancingScheme": "A String",
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
+ "oauth2ClientId": "A String",
+ "enabled": True or False,
+ "oauth2ClientSecret": "A String",
+ "oauth2ClientSecretSha256": "A String",
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ },
+ },
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, region, backendService, body)</code>
+ <pre>Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ backendService: string, Name of the BackendService resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "backendSslPolicy": { # Message containing backend SSL policies. # Backend SSL policies to enforce.
+ "pinnedPeerCertificates": [ # List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
+ "A String",
+ ],
+ },
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "loadBalancingScheme": "A String",
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "iap": { # Identity-Aware Proxy (Cloud Gatekeeper)
+ "oauth2ClientId": "A String",
+ "enabled": True or False,
+ "oauth2ClientSecret": "A String",
+ "oauth2ClientSecretSha256": "A String",
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN Coniguration for this BackendService.
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
+ "A String",
+ ],
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ },
+ },
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.regionDiskTypes.html b/docs/dyn/compute_alpha.regionDiskTypes.html
new file mode 100644
index 0000000..83f856f
--- /dev/null
+++ b/docs/dyn/compute_alpha.regionDiskTypes.html
@@ -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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionDiskTypes.html">regionDiskTypes</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, diskType)</a></code></p>
+<p class="firstline">Returns the specified regional disk type. Get a list of available disk types by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of regional disk types 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, diskType)</code>
+ <pre>Returns the specified regional disk type. Get a list of available disk types by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ diskType: string, Name of the disk type to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A DiskType resource.
+ "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
+ "description": "A String", # [Output Only] An optional description of this resource.
+ "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
+ "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of regional disk types available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Disk Type resources.
+ { # A DiskType resource.
+ "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
+ "description": "A String", # [Output Only] An optional description of this resource.
+ "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
+ "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ "kind": "compute#regionDiskTypeList", # [Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html
new file mode 100644
index 0000000..a1dd0c2
--- /dev/null
+++ b/docs/dyn/compute_alpha.regionDisks.html
@@ -0,0 +1,847 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionDisks.html">regionDisks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#createSnapshot">createSnapshot(project, region, disk, body, guestFlush=None)</a></code></p>
+<p class="firstline">Creates a snapshot of this regional disk.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, region, disk)</a></code></p>
+<p class="firstline">Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, disk)</a></code></p>
+<p class="firstline">Returns a specified regional persistent disk.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body, sourceImage=None)</a></code></p>
+<p class="firstline">Creates a persistent regional disk in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of persistent disks 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>
+<p class="toc_element">
+ <code><a href="#resize">resize(project, region, disk, body)</a></code></p>
+<p class="firstline">Resizes the specified regional persistent disk.</p>
+<p class="toc_element">
+ <code><a href="#setLabels">setLabels(project, region, resource, body)</a></code></p>
+<p class="firstline">Sets the labels on the target regional disk.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="createSnapshot">createSnapshot(project, region, disk, body, guestFlush=None)</code>
+ <pre>Creates a snapshot of this regional disk.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ disk: string, Name of the regional persistent disk to snapshot. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A persistent disk snapshot resource.
+ "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
+ "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
+ "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
+ #
+ # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a snapshot.
+ "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
+ "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+ guestFlush: boolean, A parameter
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, region, disk)</code>
+ <pre>Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ disk: string, Name of the regional persistent disk to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, disk)</code>
+ <pre>Returns a specified regional persistent disk.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ disk: string, Name of the regional persistent disk to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Disk resource.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "licenses": [ # Any applicable publicly visible licenses.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "A String",
+ ],
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
+ #
+ # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
+ "status": "A String", # [Output Only] The status of disk creation.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a disk.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
+ "A String",
+ ],
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
+ "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
+ "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "options": "A String", # Internal use only.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body, sourceImage=None)</code>
+ <pre>Creates a persistent regional disk in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A Disk resource.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "licenses": [ # Any applicable publicly visible licenses.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "A String",
+ ],
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
+ #
+ # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
+ "status": "A String", # [Output Only] The status of disk creation.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a disk.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
+ "A String",
+ ],
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
+ "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
+ "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "options": "A String", # Internal use only.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ }
+
+ 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of persistent disks contained within the specified region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of persistent disks.
+ { # A Disk resource.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "licenses": [ # Any applicable publicly visible licenses.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "A String",
+ ],
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
+ #
+ # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
+ "status": "A String", # [Output Only] The status of disk creation.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a disk.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
+ "A String",
+ ],
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
+ "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
+ "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "options": "A String", # Internal use only.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ },
+ ],
+ "kind": "compute#regionDiskList", # [Output Only] Type of resource. Always compute#regionDiskList for lists of region disks.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="resize">resize(project, region, disk, body)</code>
+ <pre>Resizes the specified regional persistent disk.
+
+Args:
+ project: string, The project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ disk: string, Name of the regional persistent disk. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "sizeGb": "A String", # The new size of the regional persistent disk, which is specified in GB.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setLabels">setLabels(project, region, resource, body)</code>
+ <pre>Sets the labels on the target regional disk.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
+ "labels": { # The labels to set for this resource.
+ "a_key": "A String",
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
new file mode 100644
index 0000000..bcd6d5c
--- /dev/null
+++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
@@ -0,0 +1,1387 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionInstanceGroupManagers.html">regionInstanceGroupManagers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#abandonInstances">abandonInstances(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, region, instanceGroupManager)</a></code></p>
+<p class="firstline">Deletes the specified managed instance group and all of the instances in that group.</p>
+<p class="toc_element">
+ <code><a href="#deleteInstances">deleteInstances(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, instanceGroupManager)</a></code></p>
+<p class="firstline">Returns all of the details about the specified managed instance group.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of managed instance groups that are contained within the specified region.</p>
+<p class="toc_element">
+ <code><a href="#listManagedInstances">listManagedInstances(project, region, instanceGroupManager)</a></code></p>
+<p class="firstline">Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.</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, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#recreateInstances">recreateInstances(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#resize">resize(project, region, instanceGroupManager, size)</a></code></p>
+<p class="firstline">Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Modifies the autohealing policy for the instances in this managed instance group.</p>
+<p class="toc_element">
+ <code><a href="#setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.</p>
+<p class="toc_element">
+ <code><a href="#setTargetPools">setTargetPools(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="abandonInstances">abandonInstances(project, region, instanceGroupManager, body)</code>
+ <pre>Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The names of one or more instances to abandon.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, region, instanceGroupManager)</code>
+ <pre>Deletes the specified managed instance group and all of the instances in that group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="deleteInstances">deleteInstances(project, region, instanceGroupManager, body)</code>
+ <pre>Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The names of one or more instances to delete.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, instanceGroupManager)</code>
+ <pre>Returns all of the details about the specified managed instance group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
+ {
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "instanceTemplate": "A String",
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
+ },
+ ],
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
+ },
+ "updatePolicy": { # The update policy for this managed instance group.
+ "type": "A String",
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
+ },
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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 a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for 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:
+
+{ # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
+ {
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "instanceTemplate": "A String",
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
+ },
+ ],
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
+ },
+ "updatePolicy": { # The update policy for this managed instance group.
+ "type": "A String",
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
+ },
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of managed instance groups that are contained within the specified region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of managed instance groups.
+ "nextPageToken": "A String", # [Output only] A token used to continue a truncated list request.
+ "items": [ # A list of managed instance groups.
+ { # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
+ {
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "instanceTemplate": "A String",
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
+ },
+ ],
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
+ },
+ "updatePolicy": { # The update policy for this managed instance group.
+ "type": "A String",
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
+ },
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ },
+ ],
+ "kind": "compute#regionInstanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output only] The URL for this resource type. The server generates this URL.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listManagedInstances">listManagedInstances(project, region, instanceGroupManager)</code>
+ <pre>Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "managedInstances": [ # List of managed instances.
+ {
+ "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
+ "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
+ "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ },
+ "tag": "A String", # [Output Only] Tag describing the version.
+ "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
+ "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
+ "standbyMode": "A String", # [Output Only] Standby mode of the instance. This field is non-empty iff the instance is a standby.
+ "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
+ # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
+ # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
+ # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
+ # - RECREATING The managed instance group is recreating this instance.
+ # - DELETING The managed instance group is permanently deleting this instance.
+ # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
+ # - RESTARTING The managed instance group is restarting the instance.
+ # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
+ "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
+ },
+ ],
+ }</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, region, instanceGroupManager, body)</code>
+ <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, The name of the instance group manager. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
+ {
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "instanceTemplate": "A String",
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
+ },
+ ],
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
+ },
+ "updatePolicy": { # The update policy for this managed instance group.
+ "type": "A String",
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
+ },
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body)</code>
+ <pre>Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The URL for one or more instances to recreate.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resize">resize(project, region, instanceGroupManager, size)</code>
+ <pre>Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ size: integer, Number of instances that should exist in this instance group manager. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body)</code>
+ <pre>Modifies the autohealing policy for the instances in this managed instance group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "autoHealingPolicies": [
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body)</code>
+ <pre>Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body)</code>
+ <pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "targetPools": [ # The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "fingerprint": "A String", # Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, region, instanceGroupManager, body)</code>
+ <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, The name of the instance group manager. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
+ {
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "instanceTemplate": "A String",
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
+ },
+ ],
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
+ },
+ "updatePolicy": { # The update policy for this managed instance group.
+ "type": "A String",
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
+ "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
+ "fixed": 42, # fixed must be non-negative.
+ "percent": 42, # percent must belong to [0, 100].
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
+ },
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.regionInstanceGroups.html b/docs/dyn/compute_alpha.regionInstanceGroups.html
new file mode 100644
index 0000000..e5beafd
--- /dev/null
+++ b/docs/dyn/compute_alpha.regionInstanceGroups.html
@@ -0,0 +1,382 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionInstanceGroups.html">regionInstanceGroups</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, instanceGroup)</a></code></p>
+<p class="firstline">Returns the specified instance group resource.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of instance group resources contained within the specified region.</p>
+<p class="toc_element">
+ <code><a href="#listInstances">listInstances(project, region, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.</p>
+<p class="toc_element">
+ <code><a href="#listInstances_next">listInstances_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="#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="#setNamedPorts">setNamedPorts(project, region, instanceGroup, body)</a></code></p>
+<p class="firstline">Sets the named ports for the specified regional instance group.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(project, region, instanceGroup)</code>
+ <pre>Returns the specified instance group resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroup: string, Name of the instance group resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "size": 42, # [Output Only] The total number of instances in the instance group.
+ "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
+ "network": "A String", # The URL of the network to which all instances in the instance group belong.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+ "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+ "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+ #
+ # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+ #
+ # Named ports apply to all instances in this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
+ "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
+ "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of instance group resources contained within the specified region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of InstanceGroup resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of InstanceGroup resources.
+ {
+ "size": 42, # [Output Only] The total number of instances in the instance group.
+ "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
+ "network": "A String", # The URL of the network to which all instances in the instance group belong.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+ "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+ "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+ #
+ # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+ #
+ # Named ports apply to all instances in this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
+ "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
+ "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ },
+ ],
+ "kind": "compute#regionInstanceGroupList", # The resource type.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listInstances">listInstances(project, region, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroup: string, Name of the regional instance group for which we want to list the instances. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "portName": "A String", # Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.
+ "instanceState": "A String", # Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.
+ }
+
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of instances and any named ports that are assigned to those instances.
+ {
+ "status": "A String", # [Output Only] The status of the instance.
+ "instance": "A String", # [Output Only] The URL of the instance.
+ "namedPorts": [ # [Output Only] The named ports that belong to this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ },
+ ],
+ "kind": "compute#regionInstanceGroupsListInstances", # The resource type.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listInstances_next">listInstances_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="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="setNamedPorts">setNamedPorts(project, region, instanceGroup, body)</code>
+ <pre>Sets the named ports for the specified regional instance group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroup: string, The name of the regional instance group where the named ports are updated. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "namedPorts": [ # The list of named ports to set for this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.operations.html b/docs/dyn/compute_alpha.regionOperations.html
similarity index 77%
copy from docs/dyn/serviceregistry_alpha.operations.html
copy to docs/dyn/compute_alpha.regionOperations.html
index eec2283..f4d6d08 100644
--- a/docs/dyn/serviceregistry_alpha.operations.html
+++ b/docs/dyn/compute_alpha.regionOperations.html
@@ -72,25 +72,40 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.operations.html">operations</a></h1>
+<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionOperations.html">regionOperations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#get">get(project, operation)</a></code></p>
-<p class="firstline">Gets information about a specific operation.</p>
+ <code><a href="#delete">delete(project, region, operation)</a></code></p>
+<p class="firstline">Deletes the specified region-specific Operations resource.</p>
<p class="toc_element">
- <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists all operations for a project.</p>
+ <code><a href="#get">get(project, region, operation)</a></code></p>
+<p class="firstline">Retrieves the specified region-specific Operations resource.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a 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="get">get(project, operation)</code>
- <pre>Gets information about a specific operation.
+ <code class="details" id="delete">delete(project, region, operation)</code>
+ <pre>Deletes the specified region-specific Operations resource.
Args:
- project: string, The project ID for this request. (required)
- operation: string, The name of the operation for this request. (required)
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ operation: string, Name of the Operations 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 Operations resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ operation: string, Name of the Operations resource to return. (required)
Returns:
An object of the form:
@@ -124,7 +139,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -138,16 +153,17 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all operations for a project.
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of Operation resources contained within the specified region.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -161,16 +177,16 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
-The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "operations": [ # [Output Only] Operations contained in this list response.
+ { # Contains a list of Operation resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Operation resources.
{ # An Operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] Reserved for future use.
@@ -200,7 +216,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -214,9 +230,12 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
},
],
+ "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_alpha.regions.html b/docs/dyn/compute_alpha.regions.html
new file mode 100644
index 0000000..5fe9c44
--- /dev/null
+++ b/docs/dyn/compute_alpha.regions.html
@@ -0,0 +1,202 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.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. Get a list of available regions by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, 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. Get a list of available regions by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Region resource.
+ "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
+ "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
+ "description": "A String", # [Output Only] Textual description of the resource.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "quotas": [ # [Output Only] Quotas assigned to this region.
+ { # A quotas entry.
+ "usage": 3.14, # [Output Only] Current usage of this metric.
+ "metric": "A String", # [Output Only] Name of the quota metric.
+ "limit": 3.14, # [Output Only] Quota limit for this metric.
+ },
+ ],
+ "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of region resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of region resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Region resources.
+ { # Region resource.
+ "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
+ "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
+ "description": "A String", # [Output Only] Textual description of the resource.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "quotas": [ # [Output Only] Quotas assigned to this region.
+ { # A quotas entry.
+ "usage": 3.14, # [Output Only] Current usage of this metric.
+ "metric": "A String", # [Output Only] Name of the quota metric.
+ "limit": 3.14, # [Output Only] Quota limit for this metric.
+ },
+ ],
+ "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ "kind": "compute#regionList", # [Output Only] Type of resource. Always compute#regionList for lists of regions.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.routers.html b/docs/dyn/compute_alpha.routers.html
new file mode 100644
index 0000000..c1af5cf
--- /dev/null
+++ b/docs/dyn/compute_alpha.routers.html
@@ -0,0 +1,890 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.routers.html">routers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of routers.</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, router)</a></code></p>
+<p class="firstline">Deletes the specified Router resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, router)</a></code></p>
+<p class="firstline">Returns the specified Router resource. Get a list of available routers by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#getRouterStatus">getRouterStatus(project, region, router)</a></code></p>
+<p class="firstline">Retrieves runtime information of the specified router.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a Router resource in the specified project and region using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of Router 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, region, router, body)</a></code></p>
+<p class="firstline">Updates the specified Router resource with the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#preview">preview(project, region, router, body)</a></code></p>
+<p class="firstline">Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, region, router, body)</a></code></p>
+<p class="firstline">Updates the specified Router resource with the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of routers.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of routers.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # A map of scoped router lists.
+ "a_key": { # Name of the scope containing this set of routers.
+ "routers": [ # List of routers contained in this scope.
+ { # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "warning": { # Informational warning which replaces the list of routers when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#routerAggregatedList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, router)</code>
+ <pre>Deletes the specified Router resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, router)</code>
+ <pre>Returns the specified Router resource. Get a list of available routers by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getRouterStatus">getRouterStatus(project, region, router)</code>
+ <pre>Retrieves runtime information of the specified router.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to query. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "compute#routerStatusResponse", # Type of resource.
+ "result": {
+ "bgpPeerStatus": [
+ {
+ "status": "A String", # Status of the BGP peer: {UP, DOWN}
+ "uptime": "A String", # Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
+ "name": "A String", # Name of this BGP peer. Unique within the Routers resource.
+ "uptimeSeconds": "A String", # Time this session has been up, in seconds. Format: 145
+ "linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls.
+ "peerIpAddress": "A String", # IP address of the remote BGP interface.
+ "advertisedRoutes": [ # Routes that were advertised to the remote BGP peer
+ { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+ #
+ # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+ #
+ # Packets that do not match any route in the sending instance's routing table are dropped.
+ "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
+ "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "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. You can specify this as a full or partial URL. For example:
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
+ "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # Fully-qualified URL of the network that this route applies to.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "destRange": "A String", # The destination range of outgoing packets that this route applies to.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ },
+ ],
+ "state": "A String", # BGP state as specified in RFC1771.
+ "ipAddress": "A String", # IP address of the local BGP interface.
+ "numLearnedRoutes": 42, # Number of routes learned from the remote BGP Peer.
+ },
+ ],
+ "network": "A String", # URI of the network to which this router belongs.
+ "bestRoutes": [ # Best routes for this router's network.
+ { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+ #
+ # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+ #
+ # Packets that do not match any route in the sending instance's routing table are dropped.
+ "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
+ "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "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. You can specify this as a full or partial URL. For example:
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
+ "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # Fully-qualified URL of the network that this route applies to.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "destRange": "A String", # The destination range of outgoing packets that this route applies to.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a Router resource in the specified project and region using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of Router resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of Router resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of Router resources.
+ { # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#routerList", # [Output Only] Type of resource. Always compute#router for routers.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, region, router, body)</code>
+ <pre>Updates the specified Router resource with the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="preview">preview(project, region, router, body)</code>
+ <pre>Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to query. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "resource": { # Router resource. # Preview of given router.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, region, router, body)</code>
+ <pre>Updates the specified Router resource with the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.routes.html b/docs/dyn/compute_alpha.routes.html
new file mode 100644
index 0000000..1101173
--- /dev/null
+++ b/docs/dyn/compute_alpha.routes.html
@@ -0,0 +1,416 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.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. Get a list of available routes by making a list() request.</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, orderBy=None, 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</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, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, route)</code>
+ <pre>Returns the specified Route resource. Get a list of available routes by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ route: string, Name of the Route resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+ #
+ # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+ #
+ # Packets that do not match any route in the sending instance's routing table are dropped.
+ "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
+ "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "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. You can specify this as a full or partial URL. For example:
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
+ "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # Fully-qualified URL of the network that this route applies to.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "destRange": "A String", # The destination range of outgoing packets that this route applies to.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ }</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, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+ #
+ # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+ #
+ # Packets that do not match any route in the sending instance's routing table are dropped.
+ "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
+ "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "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. You can specify this as a full or partial URL. For example:
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
+ "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # Fully-qualified URL of the network that this route applies to.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "destRange": "A String", # The destination range of outgoing packets that this route applies to.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of Route resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of Route resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Route resources.
+ { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+ #
+ # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+ #
+ # Packets that do not match any route in the sending instance's routing table are dropped.
+ "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
+ "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "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. You can specify this as a full or partial URL. For example:
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
+ "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # Fully-qualified URL of the network that this route applies to.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "destRange": "A String", # The destination range of outgoing packets that this route applies to.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ },
+ ],
+ "kind": "compute#routeList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.snapshots.html b/docs/dyn/compute_alpha.snapshots.html
new file mode 100644
index 0000000..d0288fd
--- /dev/null
+++ b/docs/dyn/compute_alpha.snapshots.html
@@ -0,0 +1,412 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.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 Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, snapshot)</a></code></p>
+<p class="firstline">Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of 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>
+<p class="toc_element">
+ <code><a href="#setLabels">setLabels(project, resource, body)</a></code></p>
+<p class="firstline">Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, snapshot)</code>
+ <pre>Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.
+
+For more information, see Deleting snaphots.
+
+Args:
+ project: string, Project ID for this request. (required)
+ snapshot: string, Name of the Snapshot resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, snapshot)</code>
+ <pre>Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ snapshot: string, Name of the Snapshot resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A persistent disk snapshot resource.
+ "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
+ "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
+ "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
+ #
+ # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a snapshot.
+ "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
+ "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of Snapshot resources contained within the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of Snapshot resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Snapshot resources.
+ { # A persistent disk snapshot resource.
+ "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
+ "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
+ "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
+ #
+ # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a snapshot.
+ "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
+ "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#snapshotList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="setLabels">setLabels(project, resource, body)</code>
+ <pre>Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.
+ "labels": { # A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
+ "a_key": "A String",
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.sslCertificates.html b/docs/dyn/compute_alpha.sslCertificates.html
new file mode 100644
index 0000000..94f3a58
--- /dev/null
+++ b/docs/dyn/compute_alpha.sslCertificates.html
@@ -0,0 +1,335 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.sslCertificates.html">sslCertificates</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, sslCertificate)</a></code></p>
+<p class="firstline">Deletes the specified SslCertificate resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, sslCertificate)</a></code></p>
+<p class="firstline">Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a SslCertificate resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of SslCertificate 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="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, sslCertificate)</code>
+ <pre>Deletes the specified SslCertificate resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ sslCertificate: string, Name of the SslCertificate resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, sslCertificate)</code>
+ <pre>Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ sslCertificate: string, Name of the SslCertificate resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
+ "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
+ "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a SslCertificate resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
+ "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
+ "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of SslCertificate resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of SslCertificate resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of SslCertificate resources.
+ { # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
+ "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
+ "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ },
+ ],
+ "kind": "compute#sslCertificateList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.subnetworks.html b/docs/dyn/compute_alpha.subnetworks.html
new file mode 100644
index 0000000..400c72e
--- /dev/null
+++ b/docs/dyn/compute_alpha.subnetworks.html
@@ -0,0 +1,879 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.subnetworks.html">subnetworks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of subnetworks.</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, subnetwork)</a></code></p>
+<p class="firstline">Deletes the specified subnetwork.</p>
+<p class="toc_element">
+ <code><a href="#expandIpCidrRange">expandIpCidrRange(project, region, subnetwork, body)</a></code></p>
+<p class="firstline">Expands the IP CIDR range of the subnetwork to a specified value.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, subnetwork)</a></code></p>
+<p class="firstline">Returns the specified subnetwork. Get a list of available subnetworks list() request.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(project, region, resource)</a></code></p>
+<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a subnetwork in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of subnetworks 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="#setIamPolicy">setIamPolicy(project, region, resource, body)</a></code></p>
+<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
+<p class="toc_element">
+ <code><a href="#setPrivateIpGoogleAccess">setPrivateIpGoogleAccess(project, region, subnetwork, body)</a></code></p>
+<p class="firstline">Set whether VMs in this subnet can access Google services without assigning external IP addresses through Cloudpath.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of subnetworks.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output] A map of scoped Subnetwork lists.
+ "a_key": { # Name of the scope containing this set of Subnetworks.
+ "subnetworks": [ # List of subnetworks contained in this scope.
+ { # A Subnetwork resource.
+ "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "region": "A String", # URL of the region where the Subnetwork resides.
+ "secondaryIpRanges": [ # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
+ { # Represents a secondary IP range of a subnetwork.
+ "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network.
+ "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
+ },
+ ],
+ "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
+ "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses.
+ "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
+ "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "warning": { # An informational warning that appears when the list of addresses is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#subnetworkAggregatedList", # [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, subnetwork)</code>
+ <pre>Deletes the specified subnetwork.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ subnetwork: string, Name of the Subnetwork resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="expandIpCidrRange">expandIpCidrRange(project, region, subnetwork, body)</code>
+ <pre>Expands the IP CIDR range of the subnetwork to a specified value.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ subnetwork: string, Name of the Subnetwork resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "ipCidrRange": "A String", # The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, subnetwork)</code>
+ <pre>Returns the specified subnetwork. Get a list of available subnetworks list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ subnetwork: string, Name of the Subnetwork resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Subnetwork resource.
+ "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "region": "A String", # URL of the region where the Subnetwork resides.
+ "secondaryIpRanges": [ # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
+ { # Represents a secondary IP range of a subnetwork.
+ "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network.
+ "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
+ },
+ ],
+ "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
+ "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses.
+ "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
+ "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource)</code>
+ <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a subnetwork in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for 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 Subnetwork resource.
+ "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "region": "A String", # URL of the region where the Subnetwork resides.
+ "secondaryIpRanges": [ # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
+ { # Represents a secondary IP range of a subnetwork.
+ "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network.
+ "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
+ },
+ ],
+ "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
+ "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses.
+ "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
+ "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of subnetworks available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of Subnetwork resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # The Subnetwork resources.
+ { # A Subnetwork resource.
+ "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "region": "A String", # URL of the region where the Subnetwork resides.
+ "secondaryIpRanges": [ # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
+ { # Represents a secondary IP range of a subnetwork.
+ "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network.
+ "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
+ },
+ ],
+ "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
+ "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses.
+ "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
+ "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#subnetworkList", # [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="setIamPolicy">setIamPolicy(project, region, resource, body)</code>
+ <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ #
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ #
+ # **Example**
+ #
+ # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ #
+ # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
+ #
+ # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
+ { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
+ "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ },
+ ],
+ "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ "A String",
+ ],
+ "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setPrivateIpGoogleAccess">setPrivateIpGoogleAccess(project, region, subnetwork, body)</code>
+ <pre>Set whether VMs in this subnet can access Google services without assigning external IP addresses through Cloudpath.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ subnetwork: string, Name of the Subnetwork resource. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "privateIpGoogleAccess": True or False,
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.targetHttpProxies.html b/docs/dyn/compute_alpha.targetHttpProxies.html
new file mode 100644
index 0000000..eb211c6
--- /dev/null
+++ b/docs/dyn/compute_alpha.targetHttpProxies.html
@@ -0,0 +1,400 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetHttpProxies.html">targetHttpProxies</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, targetHttpProxy)</a></code></p>
+<p class="firstline">Deletes the specified TargetHttpProxy resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, targetHttpProxy)</a></code></p>
+<p class="firstline">Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a TargetHttpProxy resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of TargetHttpProxy 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="#setUrlMap">setUrlMap(project, targetHttpProxy, body)</a></code></p>
+<p class="firstline">Changes the URL map for TargetHttpProxy.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, targetHttpProxy)</code>
+ <pre>Deletes the specified TargetHttpProxy resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, targetHttpProxy)</code>
+ <pre>Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
+ "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a TargetHttpProxy resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A TargetHttpProxy resource. This resource defines an HTTP proxy.
+ "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of TargetHttpProxy resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # A list of TargetHttpProxy resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of TargetHttpProxy resources.
+ { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
+ "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="setUrlMap">setUrlMap(project, targetHttpProxy, body)</code>
+ <pre>Changes the URL map for TargetHttpProxy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "urlMap": "A String",
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.endpoints.html b/docs/dyn/compute_alpha.targetHttpsProxies.html
similarity index 64%
copy from docs/dyn/serviceregistry_alpha.endpoints.html
copy to docs/dyn/compute_alpha.targetHttpsProxies.html
index fb47c39..c53bc13 100644
--- a/docs/dyn/serviceregistry_alpha.endpoints.html
+++ b/docs/dyn/compute_alpha.targetHttpsProxies.html
@@ -72,37 +72,40 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.endpoints.html">endpoints</a></h1>
+<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetHttpsProxies.html">targetHttpsProxies</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(project, endpoint)</a></code></p>
-<p class="firstline">Deletes an endpoint.</p>
+ <code><a href="#delete">delete(project, targetHttpsProxy)</a></code></p>
+<p class="firstline">Deletes the specified TargetHttpsProxy resource.</p>
<p class="toc_element">
- <code><a href="#get">get(project, endpoint)</a></code></p>
-<p class="firstline">Gets an endpoint.</p>
+ <code><a href="#get">get(project, targetHttpsProxy)</a></code></p>
+<p class="firstline">Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates an endpoint.</p>
+<p class="firstline">Creates a TargetHttpsProxy resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists endpoints for a project.</p>
+<p class="firstline">Retrieves the list of TargetHttpsProxy 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, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint. This method supports patch semantics.</p>
+ <code><a href="#setSslCertificates">setSslCertificates(project, targetHttpsProxy, body)</a></code></p>
+<p class="firstline">Replaces SslCertificates for TargetHttpsProxy.</p>
<p class="toc_element">
- <code><a href="#update">update(project, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint.</p>
+ <code><a href="#setUrlMap">setUrlMap(project, targetHttpsProxy, body)</a></code></p>
+<p class="firstline">Changes the URL map for TargetHttpsProxy.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(project, endpoint)</code>
- <pre>Deletes an endpoint.
+ <code class="details" id="delete">delete(project, targetHttpsProxy)</code>
+ <pre>Deletes the specified TargetHttpsProxy resource.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required)
Returns:
An object of the form:
@@ -136,7 +139,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -150,65 +153,63 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="get">get(project, endpoint)</code>
- <pre>Gets an endpoint.
+ <code class="details" id="get">get(project, targetHttpsProxy)</code>
+ <pre>Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required)
Returns:
An object of the form:
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
+ "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
+ "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
+ "A String",
+ ],
+ "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
+ # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
+ # - projects/project/global/urlMaps/url-map
+ # - global/urlMaps/url-map
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, body)</code>
- <pre>Creates an endpoint.
+ <pre>Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+{ # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
+ "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
+ "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
+ "A String",
+ ],
+ "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
+ # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
+ # - projects/project/global/urlMaps/url-map
+ # - global/urlMaps/url-map
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
@@ -244,7 +245,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -258,16 +259,16 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists endpoints for a project.
+ <pre>Retrieves the list of TargetHttpsProxy resources available to the specified project.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -281,34 +282,36 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
-The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 6
+ { # Contains a list of TargetHttpsProxy resources.
"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
- "endpoints": [ # The endpoints contained in this response.
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ "items": [ # A list of TargetHttpsProxy resources.
+ { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
+ "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
+ "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
+ "A String",
+ ],
+ "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
+ # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
+ # - projects/project/global/urlMaps/url-map
+ # - global/urlMaps/url-map
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
+ "kind": "compute#targetHttpsProxyList", # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
@@ -327,31 +330,19 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, endpoint, body)</code>
- <pre>Updates an endpoint. This method supports patch semantics.
+ <code class="details" id="setSslCertificates">setSslCertificates(project, targetHttpsProxy, body)</code>
+ <pre>Replaces SslCertificates for TargetHttpsProxy.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+{
+ "sslCertificates": [ # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.
+ "A String",
+ ],
}
@@ -387,7 +378,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -401,36 +392,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="update">update(project, endpoint, body)</code>
- <pre>Updates an endpoint.
+ <code class="details" id="setUrlMap">setUrlMap(project, targetHttpsProxy, body)</code>
+ <pre>Changes the URL map for TargetHttpsProxy.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+{
+ "urlMap": "A String",
}
@@ -466,7 +443,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -480,7 +457,34 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
}</pre>
</div>
diff --git a/docs/dyn/compute_alpha.targetInstances.html b/docs/dyn/compute_alpha.targetInstances.html
new file mode 100644
index 0000000..37ad245
--- /dev/null
+++ b/docs/dyn/compute_alpha.targetInstances.html
@@ -0,0 +1,437 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetInstances.html">targetInstances</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of target instances.</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, zone, targetInstance)</a></code></p>
+<p class="firstline">Deletes the specified TargetInstance resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, zone, targetInstance)</a></code></p>
+<p class="firstline">Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, zone, body)</a></code></p>
+<p class="firstline">Creates a TargetInstance resource in the specified project and zone using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of TargetInstance resources available to the specified project and 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of target instances.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # A map of scoped target instance lists.
+ "a_key": { # Name of the scope containing this set of target instances.
+ "targetInstances": [ # List of target instances contained in this scope.
+ { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
+ "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
+ "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
+ "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ # - zones/zone/instances/instance
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "warning": { # Informational warning which replaces the list of addresses when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#targetInstanceAggregatedList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, zone, targetInstance)</code>
+ <pre>Deletes the specified TargetInstance resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone scoping this request. (required)
+ targetInstance: string, Name of the TargetInstance resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, zone, targetInstance)</code>
+ <pre>Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone scoping this request. (required)
+ targetInstance: string, Name of the TargetInstance resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
+ "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
+ "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
+ "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ # - zones/zone/instances/instance
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, zone, body)</code>
+ <pre>Creates a TargetInstance resource in the specified project and zone using the data included in the request.
+
+Args:
+ project: string, Project ID for 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 TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
+ "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
+ "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
+ "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ # - zones/zone/instances/instance
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of TargetInstance resources available to the specified project and zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of TargetInstance resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of TargetInstance resources.
+ { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
+ "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
+ "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
+ "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ # - zones/zone/instances/instance
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#targetInstanceList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.targetPools.html b/docs/dyn/compute_alpha.targetPools.html
new file mode 100644
index 0000000..de82b7e
--- /dev/null
+++ b/docs/dyn/compute_alpha.targetPools.html
@@ -0,0 +1,906 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetPools.html">targetPools</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body)</a></code></p>
+<p class="firstline">Adds health check URLs to a target pool.</p>
+<p class="toc_element">
+ <code><a href="#addInstance">addInstance(project, region, targetPool, body)</a></code></p>
+<p class="firstline">Adds an instance to a target pool.</p>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of target pools.</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, targetPool)</a></code></p>
+<p class="firstline">Deletes the specified target pool.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, targetPool)</a></code></p>
+<p class="firstline">Returns the specified target pool. Get a list of available target pools by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#getHealth">getHealth(project, region, targetPool, body)</a></code></p>
+<p class="firstline">Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a target pool in the specified project and region using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of target pools available to the specified project and 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>
+<p class="toc_element">
+ <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body)</a></code></p>
+<p class="firstline">Removes health check URL from a target pool.</p>
+<p class="toc_element">
+ <code><a href="#removeInstance">removeInstance(project, region, targetPool, body)</a></code></p>
+<p class="firstline">Removes instance URL from a target pool.</p>
+<p class="toc_element">
+ <code><a href="#setBackup">setBackup(project, region, targetPool, body, failoverRatio=None)</a></code></p>
+<p class="firstline">Changes a backup target pool's configurations.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body)</code>
+ <pre>Adds health check URLs to a target pool.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the target pool to add a health check to. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "healthChecks": [ # A list of HttpHealthCheck resources to add to the target pool.
+ { # A full or valid partial URL to a health check. For example, the following are valid URLs:
+ # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
+ # - projects/project-id/global/httpHealthChecks/health-check
+ # - global/httpHealthChecks/health-check
+ "healthCheck": "A String",
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="addInstance">addInstance(project, region, targetPool, body)</code>
+ <pre>Adds an instance to a target pool.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the TargetPool resource to add instances to. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
+ # - projects/project-id/zones/zone/instances/instance-name
+ # - zones/zone/instances/instance-name
+ {
+ "instance": "A String", # The URL for a specific instance.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of target pools.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped target pool lists.
+ "a_key": { # Name of the scope containing this set of target pools.
+ "warning": { # Informational warning which replaces the list of addresses when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "targetPools": [ # List of target pools contained in this scope.
+ { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
+ "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
+ #
+ # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the target pool resides.
+ "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
+ "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
+ # NONE: Connections from the same client IP may go to any instance in the pool.
+ # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
+ # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
+ "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
+ "A String",
+ ],
+ "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
+ #
+ # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ },
+ },
+ "kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, targetPool)</code>
+ <pre>Deletes the specified target pool.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the TargetPool resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, targetPool)</code>
+ <pre>Returns the specified target pool. Get a list of available target pools by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the TargetPool resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
+ "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
+ #
+ # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the target pool resides.
+ "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
+ "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
+ # NONE: Connections from the same client IP may go to any instance in the pool.
+ # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
+ # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
+ "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
+ "A String",
+ ],
+ "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
+ #
+ # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getHealth">getHealth(project, region, targetPool, body)</code>
+ <pre>Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instance": "A String", # The URL for a specific instance.
+}
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
+ "healthStatus": [
+ {
+ "instance": "A String", # URL of the instance resource.
+ "healthState": "A String", # Health state of the instance.
+ "ipAddress": "A String", # The IP address represented by this resource.
+ "port": 42, # The port on the instance.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a target pool in the specified project and region using the data included in the request.
+
+Args:
+ project: string, Project ID for 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 TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
+ "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
+ #
+ # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the target pool resides.
+ "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
+ "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
+ # NONE: Connections from the same client IP may go to any instance in the pool.
+ # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
+ # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
+ "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
+ "A String",
+ ],
+ "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
+ #
+ # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of target pools available to the specified project and region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of TargetPool resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of TargetPool resources.
+ { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
+ "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
+ #
+ # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the target pool resides.
+ "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
+ "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
+ # NONE: Connections from the same client IP may go to any instance in the pool.
+ # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
+ # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
+ "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
+ "A String",
+ ],
+ "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
+ #
+ # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="removeHealthCheck">removeHealthCheck(project, region, targetPool, body)</code>
+ <pre>Removes health check URL from a target pool.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ targetPool: string, Name of the target pool to remove health checks from. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
+ # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
+ # - projects/project/global/httpHealthChecks/health-check
+ # - global/httpHealthChecks/health-check
+ { # A full or valid partial URL to a health check. For example, the following are valid URLs:
+ # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
+ # - projects/project-id/global/httpHealthChecks/health-check
+ # - global/httpHealthChecks/health-check
+ "healthCheck": "A String",
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body)</code>
+ <pre>Removes instance URL from a target pool.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the TargetPool resource to remove instances from. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # URLs of the instances to be removed from target pool.
+ {
+ "instance": "A String", # The URL for a specific instance.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setBackup">setBackup(project, region, targetPool, body, failoverRatio=None)</code>
+ <pre>Changes a backup target pool's configurations.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "target": "A String",
+ }
+
+ failoverRatio: number, New failoverRatio value for the target pool.
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.targetSslProxies.html b/docs/dyn/compute_alpha.targetSslProxies.html
new file mode 100644
index 0000000..dee0a2b
--- /dev/null
+++ b/docs/dyn/compute_alpha.targetSslProxies.html
@@ -0,0 +1,553 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetSslProxies.html">targetSslProxies</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, targetSslProxy)</a></code></p>
+<p class="firstline">Deletes the specified TargetSslProxy resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, targetSslProxy)</a></code></p>
+<p class="firstline">Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a TargetSslProxy resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of TargetSslProxy 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="#setBackendService">setBackendService(project, targetSslProxy, body)</a></code></p>
+<p class="firstline">Changes the BackendService for TargetSslProxy.</p>
+<p class="toc_element">
+ <code><a href="#setProxyHeader">setProxyHeader(project, targetSslProxy, body)</a></code></p>
+<p class="firstline">Changes the ProxyHeaderType for TargetSslProxy.</p>
+<p class="toc_element">
+ <code><a href="#setSslCertificates">setSslCertificates(project, targetSslProxy, body)</a></code></p>
+<p class="firstline">Changes SslCertificates for TargetSslProxy.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, targetSslProxy)</code>
+ <pre>Deletes the specified TargetSslProxy resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, targetSslProxy)</code>
+ <pre>Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A TargetSslProxy resource. This resource defines an SSL proxy.
+ "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
+ "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "service": "A String", # URL to the BackendService resource.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a TargetSslProxy resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A TargetSslProxy resource. This resource defines an SSL proxy.
+ "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
+ "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "service": "A String", # URL to the BackendService resource.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of TargetSslProxy resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of TargetSslProxy resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of TargetSslProxy resources.
+ { # A TargetSslProxy resource. This resource defines an SSL proxy.
+ "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
+ "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "service": "A String", # URL to the BackendService resource.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#targetSslProxyList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="setBackendService">setBackendService(project, targetSslProxy, body)</code>
+ <pre>Changes the BackendService for TargetSslProxy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "service": "A String", # The URL of the new BackendService resource for the targetSslProxy.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setProxyHeader">setProxyHeader(project, targetSslProxy, body)</code>
+ <pre>Changes the ProxyHeaderType for TargetSslProxy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setSslCertificates">setSslCertificates(project, targetSslProxy, body)</code>
+ <pre>Changes SslCertificates for TargetSslProxy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.endpoints.html b/docs/dyn/compute_alpha.targetTcpProxies.html
similarity index 64%
copy from docs/dyn/serviceregistry_alpha.endpoints.html
copy to docs/dyn/compute_alpha.targetTcpProxies.html
index fb47c39..95db661 100644
--- a/docs/dyn/serviceregistry_alpha.endpoints.html
+++ b/docs/dyn/compute_alpha.targetTcpProxies.html
@@ -72,37 +72,40 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.endpoints.html">endpoints</a></h1>
+<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetTcpProxies.html">targetTcpProxies</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(project, endpoint)</a></code></p>
-<p class="firstline">Deletes an endpoint.</p>
+ <code><a href="#delete">delete(project, targetTcpProxy)</a></code></p>
+<p class="firstline">Deletes the specified TargetTcpProxy resource.</p>
<p class="toc_element">
- <code><a href="#get">get(project, endpoint)</a></code></p>
-<p class="firstline">Gets an endpoint.</p>
+ <code><a href="#get">get(project, targetTcpProxy)</a></code></p>
+<p class="firstline">Returns the specified TargetTcpProxy resource. Get a list of available target TCP proxies by making a list() request.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates an endpoint.</p>
+<p class="firstline">Creates a TargetTcpProxy resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists endpoints for a project.</p>
+<p class="firstline">Retrieves the list of TargetTcpProxy 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, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint. This method supports patch semantics.</p>
+ <code><a href="#setBackendService">setBackendService(project, targetTcpProxy, body)</a></code></p>
+<p class="firstline">Changes the BackendService for TargetTcpProxy.</p>
<p class="toc_element">
- <code><a href="#update">update(project, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint.</p>
+ <code><a href="#setProxyHeader">setProxyHeader(project, targetTcpProxy, body)</a></code></p>
+<p class="firstline">Changes the ProxyHeaderType for TargetTcpProxy.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(project, endpoint)</code>
- <pre>Deletes an endpoint.
+ <code class="details" id="delete">delete(project, targetTcpProxy)</code>
+ <pre>Deletes the specified TargetTcpProxy resource.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetTcpProxy: string, Name of the TargetTcpProxy resource to delete. (required)
Returns:
An object of the form:
@@ -136,7 +139,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -150,65 +153,51 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="get">get(project, endpoint)</code>
- <pre>Gets an endpoint.
+ <code class="details" id="get">get(project, targetTcpProxy)</code>
+ <pre>Returns the specified TargetTcpProxy resource. Get a list of available target TCP proxies by making a list() request.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetTcpProxy: string, Name of the TargetTcpProxy resource to return. (required)
Returns:
An object of the form:
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ { # A TargetTcpProxy resource. This resource defines a TCP proxy.
+ "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "service": "A String", # URL to the BackendService resource.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, body)</code>
- <pre>Creates an endpoint.
+ <pre>Creates a TargetTcpProxy resource in the specified project using the data included in the request.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+{ # A TargetTcpProxy resource. This resource defines a TCP proxy.
+ "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "service": "A String", # URL to the BackendService resource.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
@@ -244,7 +233,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -258,16 +247,16 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists endpoints for a project.
+ <pre>Retrieves the list of TargetTcpProxy resources available to the specified project.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -281,34 +270,30 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
-The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 6
+ { # Contains a list of TargetTcpProxy resources.
"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
- "endpoints": [ # The endpoints contained in this response.
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ "items": [ # A list of TargetTcpProxy resources.
+ { # A TargetTcpProxy resource. This resource defines a TCP proxy.
+ "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "service": "A String", # URL to the BackendService resource.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
+ "kind": "compute#targetTcpProxyList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
@@ -327,31 +312,17 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, endpoint, body)</code>
- <pre>Updates an endpoint. This method supports patch semantics.
+ <code class="details" id="setBackendService">setBackendService(project, targetTcpProxy, body)</code>
+ <pre>Changes the BackendService for TargetTcpProxy.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetTcpProxy: string, Name of the TargetTcpProxy resource whose BackendService resource is to be set. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+{
+ "service": "A String", # The URL of the new BackendService resource for the targetTcpProxy.
}
@@ -387,7 +358,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -401,36 +372,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="update">update(project, endpoint, body)</code>
- <pre>Updates an endpoint.
+ <code class="details" id="setProxyHeader">setProxyHeader(project, targetTcpProxy, body)</code>
+ <pre>Changes the ProxyHeaderType for TargetTcpProxy.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetTcpProxy: string, Name of the TargetTcpProxy resource whose ProxyHeader is to be set. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+{
+ "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
}
@@ -466,7 +423,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -480,7 +437,34 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
}</pre>
</div>
diff --git a/docs/dyn/compute_alpha.targetVpnGateways.html b/docs/dyn/compute_alpha.targetVpnGateways.html
new file mode 100644
index 0000000..3453a1d
--- /dev/null
+++ b/docs/dyn/compute_alpha.targetVpnGateways.html
@@ -0,0 +1,449 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetVpnGateways.html">targetVpnGateways</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of target VPN gateways.</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, targetVpnGateway)</a></code></p>
+<p class="firstline">Deletes the specified target VPN gateway.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, targetVpnGateway)</a></code></p>
+<p class="firstline">Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a target VPN gateway in the specified project and region using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of target VPN gateways available to the specified project and 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of target VPN gateways.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # A map of scoped target vpn gateway lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of target VPN gateways.
+ "targetVpnGateways": [ # [Output Only] List of target vpn gateways contained in this scope.
+ { # Represents a Target VPN gateway resource.
+ "status": "A String", # [Output Only] The status of the VPN gateway.
+ "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
+ "A String",
+ ],
+ "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
+ "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
+ "A String",
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, targetVpnGateway)</code>
+ <pre>Deletes the specified target VPN gateway.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ targetVpnGateway: string, Name of the target VPN gateway to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, targetVpnGateway)</code>
+ <pre>Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ targetVpnGateway: string, Name of the target VPN gateway to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents a Target VPN gateway resource.
+ "status": "A String", # [Output Only] The status of the VPN gateway.
+ "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
+ "A String",
+ ],
+ "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
+ "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
+ "A String",
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a target VPN gateway in the specified project and region using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Target VPN gateway resource.
+ "status": "A String", # [Output Only] The status of the VPN gateway.
+ "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
+ "A String",
+ ],
+ "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
+ "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
+ "A String",
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of target VPN gateways available to the specified project and region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of TargetVpnGateway resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of TargetVpnGateway resources.
+ { # Represents a Target VPN gateway resource.
+ "status": "A String", # [Output Only] The status of the VPN gateway.
+ "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
+ "A String",
+ ],
+ "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
+ "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
+ "A String",
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.urlMaps.html b/docs/dyn/compute_alpha.urlMaps.html
new file mode 100644
index 0000000..8c44b76
--- /dev/null
+++ b/docs/dyn/compute_alpha.urlMaps.html
@@ -0,0 +1,813 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.urlMaps.html">urlMaps</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, urlMap)</a></code></p>
+<p class="firstline">Deletes the specified UrlMap resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, urlMap)</a></code></p>
+<p class="firstline">Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a UrlMap resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#invalidateCache">invalidateCache(project, urlMap, body)</a></code></p>
+<p class="firstline">Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of UrlMap 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, urlMap, body)</a></code></p>
+<p class="firstline">Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, urlMap, body)</a></code></p>
+<p class="firstline">Updates the specified UrlMap resource with the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#validate">validate(project, urlMap, body)</a></code></p>
+<p class="firstline">Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, urlMap)</code>
+ <pre>Deletes the specified UrlMap resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ urlMap: string, Name of the UrlMap resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, urlMap)</code>
+ <pre>Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ urlMap: string, Name of the UrlMap resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
+ "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
+ "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
+ { # Message for the expected URL mappings.
+ "path": "A String", # Path portion of the URL.
+ "host": "A String", # Host portion of the URL.
+ "description": "A String", # Description of this test case.
+ "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
+ "pathMatchers": [ # The list of named PathMatchers to use against the URL.
+ { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
+ "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
+ # - compute/v1/projects/project/global/backendServices/backendService
+ # - global/backendServices/backendService
+ "pathRules": [ # The list of path rules.
+ { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
+ "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
+ "A String",
+ ],
+ "service": "A String", # The URL of the BackendService resource if this rule is matched.
+ },
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "hostRules": [ # The list of HostRules to use against the URL.
+ { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
+ "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
+ },
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a UrlMap resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
+ "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
+ "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
+ { # Message for the expected URL mappings.
+ "path": "A String", # Path portion of the URL.
+ "host": "A String", # Host portion of the URL.
+ "description": "A String", # Description of this test case.
+ "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
+ "pathMatchers": [ # The list of named PathMatchers to use against the URL.
+ { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
+ "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
+ # - compute/v1/projects/project/global/backendServices/backendService
+ # - global/backendServices/backendService
+ "pathRules": [ # The list of path rules.
+ { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
+ "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
+ "A String",
+ ],
+ "service": "A String", # The URL of the BackendService resource if this rule is matched.
+ },
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "hostRules": [ # The list of HostRules to use against the URL.
+ { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
+ "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
+ },
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="invalidateCache">invalidateCache(project, urlMap, body)</code>
+ <pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
+
+Args:
+ project: string, Project ID for this request. (required)
+ urlMap: string, Name of the UrlMap scoping this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "path": "A String",
+ "host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of UrlMap resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of UrlMap resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of UrlMap resources.
+ { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
+ "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
+ "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
+ { # Message for the expected URL mappings.
+ "path": "A String", # Path portion of the URL.
+ "host": "A String", # Host portion of the URL.
+ "description": "A String", # Description of this test case.
+ "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
+ "pathMatchers": [ # The list of named PathMatchers to use against the URL.
+ { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
+ "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
+ # - compute/v1/projects/project/global/backendServices/backendService
+ # - global/backendServices/backendService
+ "pathRules": [ # The list of path rules.
+ { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
+ "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
+ "A String",
+ ],
+ "service": "A String", # The URL of the BackendService resource if this rule is matched.
+ },
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "hostRules": [ # The list of HostRules to use against the URL.
+ { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
+ "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
+ },
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#urlMapList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, urlMap, body)</code>
+ <pre>Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ urlMap: string, Name of the UrlMap resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
+ "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
+ "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
+ { # Message for the expected URL mappings.
+ "path": "A String", # Path portion of the URL.
+ "host": "A String", # Host portion of the URL.
+ "description": "A String", # Description of this test case.
+ "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
+ "pathMatchers": [ # The list of named PathMatchers to use against the URL.
+ { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
+ "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
+ # - compute/v1/projects/project/global/backendServices/backendService
+ # - global/backendServices/backendService
+ "pathRules": [ # The list of path rules.
+ { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
+ "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
+ "A String",
+ ],
+ "service": "A String", # The URL of the BackendService resource if this rule is matched.
+ },
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "hostRules": [ # The list of HostRules to use against the URL.
+ { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
+ "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
+ },
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, urlMap, body)</code>
+ <pre>Updates the specified UrlMap resource with the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ urlMap: string, Name of the UrlMap resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
+ "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
+ "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
+ { # Message for the expected URL mappings.
+ "path": "A String", # Path portion of the URL.
+ "host": "A String", # Host portion of the URL.
+ "description": "A String", # Description of this test case.
+ "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
+ "pathMatchers": [ # The list of named PathMatchers to use against the URL.
+ { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
+ "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
+ # - compute/v1/projects/project/global/backendServices/backendService
+ # - global/backendServices/backendService
+ "pathRules": [ # The list of path rules.
+ { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
+ "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
+ "A String",
+ ],
+ "service": "A String", # The URL of the BackendService resource if this rule is matched.
+ },
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "hostRules": [ # The list of HostRules to use against the URL.
+ { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
+ "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
+ },
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="validate">validate(project, urlMap, body)</code>
+ <pre>Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.
+
+Args:
+ project: string, Project ID for this request. (required)
+ urlMap: string, Name of the UrlMap resource to be validated as. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "resource": { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. # Content of the UrlMap to be validated.
+ "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
+ "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
+ { # Message for the expected URL mappings.
+ "path": "A String", # Path portion of the URL.
+ "host": "A String", # Host portion of the URL.
+ "description": "A String", # Description of this test case.
+ "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
+ "pathMatchers": [ # The list of named PathMatchers to use against the URL.
+ { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
+ "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
+ # - compute/v1/projects/project/global/backendServices/backendService
+ # - global/backendServices/backendService
+ "pathRules": [ # The list of path rules.
+ { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
+ "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
+ "A String",
+ ],
+ "service": "A String", # The URL of the BackendService resource if this rule is matched.
+ },
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "hostRules": [ # The list of HostRules to use against the URL.
+ { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
+ "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
+ },
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "result": { # Message representing the validation result for a UrlMap.
+ "testFailures": [
+ {
+ "path": "A String",
+ "actualService": "A String",
+ "host": "A String",
+ "expectedService": "A String",
+ },
+ ],
+ "loadErrors": [
+ "A String",
+ ],
+ "testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.
+ "loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.vpnTunnels.html b/docs/dyn/compute_alpha.vpnTunnels.html
new file mode 100644
index 0000000..8e153ba
--- /dev/null
+++ b/docs/dyn/compute_alpha.vpnTunnels.html
@@ -0,0 +1,497 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.vpnTunnels.html">vpnTunnels</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of VPN tunnels.</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, vpnTunnel)</a></code></p>
+<p class="firstline">Deletes the specified VpnTunnel resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, vpnTunnel)</a></code></p>
+<p class="firstline">Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a VpnTunnel resource in the specified project and region using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of VpnTunnel resources contained in the specified project and 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of VPN tunnels.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped vpn tunnel lists.
+ "a_key": { # Name of the scope containing this set of vpn tunnels.
+ "vpnTunnels": [ # List of vpn tunnels contained in this scope.
+ {
+ "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
+ "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
+ "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "peerIp": "A String", # IP address of the peer VPN gateway.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
+ "labels": { # Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
+ "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "status": "A String", # [Output Only] The status of the VPN tunnel.
+ "sharedSecretHash": "A String", # Hash of the shared secret.
+ "router": "A String", # URL of router resource to be used for dynamic routing.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+ "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "warning": { # Informational warning which replaces the list of addresses when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, vpnTunnel)</code>
+ <pre>Deletes the specified VpnTunnel resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ vpnTunnel: string, Name of the VpnTunnel resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, vpnTunnel)</code>
+ <pre>Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ vpnTunnel: string, Name of the VpnTunnel resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
+ "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
+ "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "peerIp": "A String", # IP address of the peer VPN gateway.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
+ "labels": { # Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
+ "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "status": "A String", # [Output Only] The status of the VPN tunnel.
+ "sharedSecretHash": "A String", # Hash of the shared secret.
+ "router": "A String", # URL of router resource to be used for dynamic routing.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+ "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a VpnTunnel resource in the specified project and region using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
+ "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
+ "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "peerIp": "A String", # IP address of the peer VPN gateway.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
+ "labels": { # Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
+ "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "status": "A String", # [Output Only] The status of the VPN tunnel.
+ "sharedSecretHash": "A String", # Hash of the shared secret.
+ "router": "A String", # URL of router resource to be used for dynamic routing.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+ "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of VpnTunnel resources contained in the specified project and region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of VpnTunnel resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of VpnTunnel resources.
+ {
+ "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
+ "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
+ "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "peerIp": "A String", # IP address of the peer VPN gateway.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
+ "labels": { # Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
+ "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "status": "A String", # [Output Only] The status of the VPN tunnel.
+ "sharedSecretHash": "A String", # Hash of the shared secret.
+ "router": "A String", # URL of router resource to be used for dynamic routing.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+ "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.operations.html b/docs/dyn/compute_alpha.zoneOperations.html
similarity index 77%
copy from docs/dyn/serviceregistry_alpha.operations.html
copy to docs/dyn/compute_alpha.zoneOperations.html
index eec2283..6a5cb37 100644
--- a/docs/dyn/serviceregistry_alpha.operations.html
+++ b/docs/dyn/compute_alpha.zoneOperations.html
@@ -72,25 +72,40 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.operations.html">operations</a></h1>
+<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.zoneOperations.html">zoneOperations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#get">get(project, operation)</a></code></p>
-<p class="firstline">Gets information about a specific operation.</p>
+ <code><a href="#delete">delete(project, zone, operation)</a></code></p>
+<p class="firstline">Deletes the specified zone-specific Operations resource.</p>
<p class="toc_element">
- <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists all operations for a project.</p>
+ <code><a href="#get">get(project, zone, operation)</a></code></p>
+<p class="firstline">Retrieves the specified zone-specific Operations resource.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a 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="get">get(project, operation)</code>
- <pre>Gets information about a specific operation.
+ <code class="details" id="delete">delete(project, zone, operation)</code>
+ <pre>Deletes the specified zone-specific Operations resource.
Args:
- project: string, The project ID for this request. (required)
- operation: string, The name of the operation for this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ operation: string, Name of the Operations 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 Operations resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ operation: string, Name of the Operations resource to return. (required)
Returns:
An object of the form:
@@ -124,7 +139,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -138,16 +153,17 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all operations for a project.
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of Operation resources contained within the specified zone.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -161,16 +177,16 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
-The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "operations": [ # [Output Only] Operations contained in this list response.
+ { # Contains a list of Operation resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Operation resources.
{ # An Operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] Reserved for future use.
@@ -200,7 +216,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -214,9 +230,12 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
},
],
+ "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_alpha.zones.html b/docs/dyn/compute_alpha.zones.html
new file mode 100644
index 0000000..7f366de
--- /dev/null
+++ b/docs/dyn/compute_alpha.zones.html
@@ -0,0 +1,184 @@
+<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.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. Get a list of available zones by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, 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. Get a list of available zones by making a list() request.
+
+Args:
+ project: string, Project ID for 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", # [Output Only] Status of the zone, either UP or DOWN.
+ "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
+ "description": "A String", # [Output Only] Textual description of the resource.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of Zone resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of zone resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Zone resources.
+ { # A Zone resource.
+ "status": "A String", # [Output Only] Status of the zone, either UP or DOWN.
+ "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
+ "description": "A String", # [Output Only] Textual description of the resource.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ "kind": "compute#zoneList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.addresses.html b/docs/dyn/compute_beta.addresses.html
new file mode 100644
index 0000000..5fd99ba
--- /dev/null
+++ b/docs/dyn/compute_beta.addresses.html
@@ -0,0 +1,437 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.addresses.html">addresses</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of addresses.</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, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of addresses 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of addresses.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped address lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of addresses.
+ "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "addresses": [ # [Output Only] List of addresses contained in this scope.
+ { # A reserved address resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ },
+ },
+ "kind": "compute#addressAggregatedList", # [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, Project ID for this request. (required)
+ region: string, Name of the region for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, address)</code>
+ <pre>Returns the specified address resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for 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", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</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, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A reserved address resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of addresses contained within the specified region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of addresses.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of addresses.
+ { # A reserved address resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }</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="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.autoscalers.html b/docs/dyn/compute_beta.autoscalers.html
new file mode 100644
index 0000000..961db44
--- /dev/null
+++ b/docs/dyn/compute_beta.autoscalers.html
@@ -0,0 +1,807 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.autoscalers.html">autoscalers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of autoscalers.</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, zone, autoscaler)</a></code></p>
+<p class="firstline">Deletes the specified autoscaler.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, zone, autoscaler)</a></code></p>
+<p class="firstline">Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, zone, body)</a></code></p>
+<p class="firstline">Creates an autoscaler in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of autoscalers 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>
+<p class="toc_element">
+ <code><a href="#patch">patch(project, zone, autoscaler, body)</a></code></p>
+<p class="firstline">Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, zone, body, autoscaler=None)</a></code></p>
+<p class="firstline">Updates an autoscaler in the specified project using the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of autoscalers.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # A map of scoped autoscaler lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of autoscalers.
+ "warning": { # [Output Only] Informational warning which replaces the list of autoscalers when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "autoscalers": [ # [Output Only] List of autoscalers contained in this scope.
+ { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ },
+ },
+ "kind": "compute#autoscalerAggregatedList", # [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, zone, autoscaler)</code>
+ <pre>Deletes the specified autoscaler.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ autoscaler: string, Name of the autoscaler to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, zone, autoscaler)</code>
+ <pre>Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ autoscaler: string, Name of the autoscaler to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, zone, body)</code>
+ <pre>Creates an autoscaler in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of autoscalers contained within the specified zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of Autoscaler resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of Autoscaler resources.
+ { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#autoscalerList", # [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, zone, autoscaler, body)</code>
+ <pre>Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ autoscaler: string, Name of the autoscaler to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, zone, body, autoscaler=None)</code>
+ <pre>Updates an autoscaler in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+ autoscaler: string, Name of the autoscaler to update.
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html
new file mode 100644
index 0000000..43e35c1
--- /dev/null
+++ b/docs/dyn/compute_beta.backendServices.html
@@ -0,0 +1,990 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.backendServices.html">backendServices</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of all BackendService resources, regional and global, available to the specified project.</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, backendService)</a></code></p>
+<p class="firstline">Deletes the specified BackendService resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, backendService)</a></code></p>
+<p class="firstline">Returns the specified BackendService resource. Get a list of available backend services by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#getHealth">getHealth(project, backendService, body)</a></code></p>
+<p class="firstline">Gets the most recent health check results for this BackendService.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of BackendService 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, backendService, body)</a></code></p>
+<p class="firstline">Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, backendService, body)</a></code></p>
+<p class="firstline">Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of all BackendService resources, regional and global, available to the specified project.
+
+Args:
+ project: string, Name of the project scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of BackendServicesScopedList.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": { # A map of scoped BackendService lists.
+ "a_key": { # Name of the scope containing this set of BackendServices.
+ "warning": { # Informational warning which replaces the list of backend services when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "backendServices": [ # List of BackendServices contained in this scope.
+ { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "loadBalancingScheme": "A String",
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ },
+ },
+ "kind": "compute#backendServiceAggregatedList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, backendService)</code>
+ <pre>Deletes the specified BackendService resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ backendService: string, Name of the BackendService resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, backendService)</code>
+ <pre>Returns the specified BackendService resource. Get a list of available backend services by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ backendService: string, Name of the BackendService resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "loadBalancingScheme": "A String",
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getHealth">getHealth(project, backendService, body)</code>
+ <pre>Gets the most recent health check results for this BackendService.
+
+Args:
+ project: string, A parameter (required)
+ backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "group": "A String", # A URI referencing one of the instance groups listed in the backend service.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
+ "healthStatus": [
+ {
+ "instance": "A String", # URL of the instance resource.
+ "healthState": "A String", # Health state of the instance.
+ "ipAddress": "A String", # The IP address represented by this resource.
+ "port": 42, # The port on the instance.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "loadBalancingScheme": "A String",
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of BackendService resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of BackendService resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # A list of BackendService resources.
+ { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "loadBalancingScheme": "A String",
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, backendService, body)</code>
+ <pre>Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ backendService: string, Name of the BackendService resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "loadBalancingScheme": "A String",
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, backendService, body)</code>
+ <pre>Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ backendService: string, Name of the BackendService resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "loadBalancingScheme": "A String",
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.diskTypes.html b/docs/dyn/compute_beta.diskTypes.html
new file mode 100644
index 0000000..d9dcd1f
--- /dev/null
+++ b/docs/dyn/compute_beta.diskTypes.html
@@ -0,0 +1,277 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.diskTypes.html">diskTypes</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of disk types.</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, diskType)</a></code></p>
+<p class="firstline">Returns the specified disk type. Get a list of available disk types by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of disk types 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, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of disk types.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped disk type lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of disk types.
+ "warning": { # [Output Only] Informational warning which replaces the list of disk types when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "diskTypes": [ # [Output Only] List of disk types contained in this scope.
+ { # A DiskType resource.
+ "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
+ "description": "A String", # [Output Only] An optional description of this resource.
+ "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
+ "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ },
+ },
+ "kind": "compute#diskTypeAggregatedList", # [Output Only] Type of resource. Always compute#diskTypeAggregatedList.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, diskType)</code>
+ <pre>Returns the specified disk type. Get a list of available disk types by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ diskType: string, Name of the disk type to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A DiskType resource.
+ "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
+ "description": "A String", # [Output Only] An optional description of this resource.
+ "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
+ "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of disk types available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of disk types.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Disk Type resources.
+ { # A DiskType resource.
+ "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
+ "description": "A String", # [Output Only] An optional description of this resource.
+ "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
+ "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ "kind": "compute#diskTypeList", # [Output Only] Type of resource. Always compute#diskTypeList for disk types.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.disks.html b/docs/dyn/compute_beta.disks.html
new file mode 100644
index 0000000..f4b58b6
--- /dev/null
+++ b/docs/dyn/compute_beta.disks.html
@@ -0,0 +1,995 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.disks.html">disks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of persistent disks.</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, guestFlush=None)</a></code></p>
+<p class="firstline">Creates a snapshot of a specified persistent disk.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, zone, disk)</a></code></p>
+<p class="firstline">Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, zone, disk)</a></code></p>
+<p class="firstline">Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.</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 in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of persistent disks 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>
+<p class="toc_element">
+ <code><a href="#resize">resize(project, zone, disk, body)</a></code></p>
+<p class="firstline">Resizes the specified persistent disk.</p>
+<p class="toc_element">
+ <code><a href="#setLabels">setLabels(project, zone, resource, body)</a></code></p>
+<p class="firstline">Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of persistent disks.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped disk lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of disks.
+ "disks": [ # [Output Only] List of disks contained in this scope.
+ { # A Disk resource.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "licenses": [ # Any applicable publicly visible licenses.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "A String",
+ ],
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
+ #
+ # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
+ "status": "A String", # [Output Only] The status of disk creation.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a disk.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
+ "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "options": "A String", # Internal use only.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ },
+ ],
+ "warning": { # [Output Only] Informational warning which replaces the list of disks when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#diskAggregatedList", # [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, guestFlush=None)</code>
+ <pre>Creates a snapshot of a specified persistent disk.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the persistent disk to snapshot. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A persistent disk snapshot resource.
+ "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
+ "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
+ "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
+ #
+ # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a snapshot.
+ "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
+ "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+ guestFlush: boolean, A parameter
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, zone, disk)</code>
+ <pre>Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the persistent disk to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, zone, disk)</code>
+ <pre>Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the persistent disk to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Disk resource.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "licenses": [ # Any applicable publicly visible licenses.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "A String",
+ ],
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
+ #
+ # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
+ "status": "A String", # [Output Only] The status of disk creation.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a disk.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
+ "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "options": "A String", # Internal use only.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, zone, body, sourceImage=None)</code>
+ <pre>Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A Disk resource.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "licenses": [ # Any applicable publicly visible licenses.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "A String",
+ ],
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
+ #
+ # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
+ "status": "A String", # [Output Only] The status of disk creation.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a disk.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
+ "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "options": "A String", # Internal use only.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ }
+
+ 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of persistent disks contained within the specified zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # A list of Disk resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of persistent disks.
+ { # A Disk resource.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "licenses": [ # Any applicable publicly visible licenses.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "A String",
+ ],
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.
+ #
+ # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "zone": "A String", # [Output Only] URL of the zone where the disk resides.
+ "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
+ "status": "A String", # [Output Only] The status of disk creation.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "storageType": "A String", # [Deprecated] Storage type of the persistent disk.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a disk.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
+ #
+ # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
+ "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "options": "A String", # Internal use only.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ },
+ ],
+ "kind": "compute#diskList", # [Output Only] Type of resource. Always compute#diskList for lists of disks.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="resize">resize(project, zone, disk, body)</code>
+ <pre>Resizes the specified persistent disk.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, The name of the persistent disk. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "sizeGb": "A String", # The new size of the persistent disk, which is specified in GB.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setLabels">setLabels(project, zone, resource, body)</code>
+ <pre>Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
+ "labels": { # The labels to set for this resource.
+ "a_key": "A String",
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.firewalls.html b/docs/dyn/compute_beta.firewalls.html
new file mode 100644
index 0000000..5a71457
--- /dev/null
+++ b/docs/dyn/compute_beta.firewalls.html
@@ -0,0 +1,600 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.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.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, firewall)</a></code></p>
+<p class="firstline">Returns the specified firewall.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a firewall rule in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of firewall rules 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 rule with the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, firewall, body)</a></code></p>
+<p class="firstline">Updates the specified firewall rule 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.
+
+Args:
+ project: string, Project ID for this request. (required)
+ firewall: string, Name of the firewall rule to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, firewall)</code>
+ <pre>Returns the specified firewall.
+
+Args:
+ project: string, Project ID for this request. (required)
+ firewall: string, Name of the firewall rule to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents a Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a firewall rule in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of firewall rules available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of firewalls.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Firewall resources.
+ { # Represents a Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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 rule with the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ firewall: string, Name of the firewall rule to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, firewall, body)</code>
+ <pre>Updates the specified firewall rule with the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ firewall: string, Name of the firewall rule to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Firewall resource.
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
+ "A String",
+ ],
+ "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
+ # global/networks/default
+ # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
+ # - projects/myproject/global/networks/my-network
+ # - global/networks/default
+ "targetTags": [ # A list of instance tags indicating sets of instances located in the network that 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 ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.forwardingRules.html b/docs/dyn/compute_beta.forwardingRules.html
new file mode 100644
index 0000000..efbd737
--- /dev/null
+++ b/docs/dyn/compute_beta.forwardingRules.html
@@ -0,0 +1,618 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.forwardingRules.html">forwardingRules</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of forwarding rules.</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, forwardingRule)</a></code></p>
+<p class="firstline">Deletes the specified ForwardingRule resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, forwardingRule)</a></code></p>
+<p class="firstline">Returns the specified ForwardingRule resource.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a ForwardingRule resource in the specified project and region using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of ForwardingRule resources available to the specified project and 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>
+<p class="toc_element">
+ <code><a href="#setTarget">setTarget(project, region, forwardingRule, body)</a></code></p>
+<p class="firstline">Changes target URL for forwarding rule. The new target should be of the same type as the old target.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of forwarding rules.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # A map of scoped forwarding rule lists.
+ "a_key": { # Name of the scope containing this set of addresses.
+ "forwardingRules": [ # List of forwarding rules contained in this scope.
+ { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "warning": { # Informational warning which replaces the list of forwarding rules when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#forwardingRuleAggregatedList", # [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, forwardingRule)</code>
+ <pre>Deletes the specified ForwardingRule resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ forwardingRule: string, Name of the ForwardingRule resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, forwardingRule)</code>
+ <pre>Returns the specified ForwardingRule resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ forwardingRule: string, Name of the ForwardingRule resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a ForwardingRule resource in the specified project and region using the data included in the request.
+
+Args:
+ project: string, Project ID for 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 ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of ForwardingRule resources available to the specified project and region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of ForwardingRule resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of ForwardingRule resources.
+ { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#forwardingRuleList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="setTarget">setTarget(project, region, forwardingRule, body)</code>
+ <pre>Changes target URL for forwarding rule. The new target should be of the same type as the old target.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "target": "A String",
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.globalAddresses.html b/docs/dyn/compute_beta.globalAddresses.html
new file mode 100644
index 0000000..8302599
--- /dev/null
+++ b/docs/dyn/compute_beta.globalAddresses.html
@@ -0,0 +1,347 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.globalAddresses.html">globalAddresses</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, address)</a></code></p>
+<p class="firstline">Deletes the specified address resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, address)</a></code></p>
+<p class="firstline">Returns the specified address resource. Get a list of available addresses by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, 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, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of global addresses.</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="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, address)</code>
+ <pre>Deletes the specified address resource.
+
+Args:
+ project: string, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, address)</code>
+ <pre>Returns the specified address resource. Get a list of available addresses by making a list() request.
+
+Args:
+ project: string, Project ID for 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", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates an address resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A reserved address resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of global addresses.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of addresses.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of addresses.
+ { # A reserved address resource.
+ "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
+ "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
+ "address": "A String", # The static external IP address represented by this resource.
+ "users": [ # [Output Only] The URLs of the resources that are using this address.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }</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="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.globalForwardingRules.html b/docs/dyn/compute_beta.globalForwardingRules.html
new file mode 100644
index 0000000..d8b3670
--- /dev/null
+++ b/docs/dyn/compute_beta.globalForwardingRules.html
@@ -0,0 +1,499 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.globalForwardingRules.html">globalForwardingRules</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, forwardingRule)</a></code></p>
+<p class="firstline">Deletes the specified ForwardingRule resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, forwardingRule)</a></code></p>
+<p class="firstline">Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a ForwardingRule resource in the specified project and region using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of ForwardingRule 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="#setTarget">setTarget(project, forwardingRule, body)</a></code></p>
+<p class="firstline">Changes target URL for forwarding rule. The new target should be of the same type as the old target.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, forwardingRule)</code>
+ <pre>Deletes the specified ForwardingRule resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ forwardingRule: string, Name of the ForwardingRule resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, forwardingRule)</code>
+ <pre>Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ forwardingRule: string, Name of the ForwardingRule resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a ForwardingRule resource in the specified project and region using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of ForwardingRule resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of ForwardingRule resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of ForwardingRule resources.
+ { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
+ "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "IPAddress": "A String", # The IP address that this forwarding rule is serving on behalf of.
+ #
+ # For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
+ #
+ # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
+ "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
+ "ports": [ # This field is not used for external load balancing.
+ #
+ # When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
+ #
+ # You may specify a maximum of up to 5 ports.
+ "A String",
+ ],
+ "network": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
+ "loadBalancingScheme": "A String", # This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
+ "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+ #
+ # This field is not used for internal load balancing.
+ "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
+ #
+ # This field is not used for internal load balancing.
+ "backendService": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
+ #
+ # When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
+ "subnetwork": "A String", # This field is not used for external load balancing.
+ #
+ # For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
+ #
+ # If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#forwardingRuleList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="setTarget">setTarget(project, forwardingRule, body)</code>
+ <pre>Changes target URL for forwarding rule. The new target should be of the same type as the old target.
+
+Args:
+ project: string, Project ID for this request. (required)
+ forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "target": "A String",
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.globalOperations.html b/docs/dyn/compute_beta.globalOperations.html
new file mode 100644
index 0000000..8983a9d
--- /dev/null
+++ b/docs/dyn/compute_beta.globalOperations.html
@@ -0,0 +1,369 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.globalOperations.html">globalOperations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of all operations.</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 Operations resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, operation)</a></code></p>
+<p class="firstline">Retrieves the specified Operations resource. Get a list of operations by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a 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, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of all operations.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped operation lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of operations.
+ "operations": [ # [Output Only] List of operations contained in this scope.
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ ],
+ "warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#operationAggregatedList", # [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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 Operations resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ operation: string, Name of the Operations resource to delete. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, operation)</code>
+ <pre>Retrieves the specified Operations resource. Get a list of operations by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ operation: string, Name of the Operations resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of Operation resources contained within the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of Operation resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Operation resources.
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ ],
+ "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.healthChecks.html b/docs/dyn/compute_beta.healthChecks.html
new file mode 100644
index 0000000..58ecb90
--- /dev/null
+++ b/docs/dyn/compute_beta.healthChecks.html
@@ -0,0 +1,675 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.healthChecks.html">healthChecks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, healthCheck)</a></code></p>
+<p class="firstline">Deletes the specified HealthCheck resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, healthCheck)</a></code></p>
+<p class="firstline">Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a HealthCheck resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of HealthCheck 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, healthCheck, body)</a></code></p>
+<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, healthCheck, body)</a></code></p>
+<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, healthCheck)</code>
+ <pre>Deletes the specified HealthCheck resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ healthCheck: string, Name of the HealthCheck resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, healthCheck)</code>
+ <pre>Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ healthCheck: string, Name of the HealthCheck resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ },
+ "httpsHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a HealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ },
+ "httpsHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of HealthCheck resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of HealthCheck resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of HealthCheck resources.
+ { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ },
+ "httpsHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#healthCheckList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, healthCheck, body)</code>
+ <pre>Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ healthCheck: string, Name of the HealthCheck resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ },
+ "httpsHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, healthCheck, body)</code>
+ <pre>Updates a HealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ healthCheck: string, Name of the HealthCheck resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
+ "kind": "compute#healthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+ "tcpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "httpHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 80.
+ "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ },
+ "httpsHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ },
+ "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ },
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "sslHealthCheck": {
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "port": 42, # The TCP port number for the health check request. The default value is 443.
+ "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
+ },
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.html b/docs/dyn/compute_beta.html
new file mode 100644
index 0000000..025623f
--- /dev/null
+++ b/docs/dyn/compute_beta.html
@@ -0,0 +1,313 @@
+<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_beta.html">Compute Engine API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="compute_beta.addresses.html">addresses()</a></code>
+</p>
+<p class="firstline">Returns the addresses Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.autoscalers.html">autoscalers()</a></code>
+</p>
+<p class="firstline">Returns the autoscalers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.backendServices.html">backendServices()</a></code>
+</p>
+<p class="firstline">Returns the backendServices Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.diskTypes.html">diskTypes()</a></code>
+</p>
+<p class="firstline">Returns the diskTypes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.disks.html">disks()</a></code>
+</p>
+<p class="firstline">Returns the disks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.firewalls.html">firewalls()</a></code>
+</p>
+<p class="firstline">Returns the firewalls Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.forwardingRules.html">forwardingRules()</a></code>
+</p>
+<p class="firstline">Returns the forwardingRules Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.globalAddresses.html">globalAddresses()</a></code>
+</p>
+<p class="firstline">Returns the globalAddresses Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.globalForwardingRules.html">globalForwardingRules()</a></code>
+</p>
+<p class="firstline">Returns the globalForwardingRules Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.globalOperations.html">globalOperations()</a></code>
+</p>
+<p class="firstline">Returns the globalOperations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.healthChecks.html">healthChecks()</a></code>
+</p>
+<p class="firstline">Returns the healthChecks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.httpHealthChecks.html">httpHealthChecks()</a></code>
+</p>
+<p class="firstline">Returns the httpHealthChecks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.httpsHealthChecks.html">httpsHealthChecks()</a></code>
+</p>
+<p class="firstline">Returns the httpsHealthChecks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.images.html">images()</a></code>
+</p>
+<p class="firstline">Returns the images Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.instanceGroupManagers.html">instanceGroupManagers()</a></code>
+</p>
+<p class="firstline">Returns the instanceGroupManagers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.instanceGroups.html">instanceGroups()</a></code>
+</p>
+<p class="firstline">Returns the instanceGroups Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.instanceTemplates.html">instanceTemplates()</a></code>
+</p>
+<p class="firstline">Returns the instanceTemplates Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.instances.html">instances()</a></code>
+</p>
+<p class="firstline">Returns the instances Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.licenses.html">licenses()</a></code>
+</p>
+<p class="firstline">Returns the licenses Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.machineTypes.html">machineTypes()</a></code>
+</p>
+<p class="firstline">Returns the machineTypes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.networks.html">networks()</a></code>
+</p>
+<p class="firstline">Returns the networks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.projects.html">projects()</a></code>
+</p>
+<p class="firstline">Returns the projects Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.regionAutoscalers.html">regionAutoscalers()</a></code>
+</p>
+<p class="firstline">Returns the regionAutoscalers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.regionBackendServices.html">regionBackendServices()</a></code>
+</p>
+<p class="firstline">Returns the regionBackendServices Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.regionInstanceGroupManagers.html">regionInstanceGroupManagers()</a></code>
+</p>
+<p class="firstline">Returns the regionInstanceGroupManagers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.regionInstanceGroups.html">regionInstanceGroups()</a></code>
+</p>
+<p class="firstline">Returns the regionInstanceGroups Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.regionOperations.html">regionOperations()</a></code>
+</p>
+<p class="firstline">Returns the regionOperations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.regions.html">regions()</a></code>
+</p>
+<p class="firstline">Returns the regions Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.routers.html">routers()</a></code>
+</p>
+<p class="firstline">Returns the routers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.routes.html">routes()</a></code>
+</p>
+<p class="firstline">Returns the routes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.snapshots.html">snapshots()</a></code>
+</p>
+<p class="firstline">Returns the snapshots Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.sslCertificates.html">sslCertificates()</a></code>
+</p>
+<p class="firstline">Returns the sslCertificates Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.subnetworks.html">subnetworks()</a></code>
+</p>
+<p class="firstline">Returns the subnetworks Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.targetHttpProxies.html">targetHttpProxies()</a></code>
+</p>
+<p class="firstline">Returns the targetHttpProxies Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.targetHttpsProxies.html">targetHttpsProxies()</a></code>
+</p>
+<p class="firstline">Returns the targetHttpsProxies Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.targetInstances.html">targetInstances()</a></code>
+</p>
+<p class="firstline">Returns the targetInstances Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.targetPools.html">targetPools()</a></code>
+</p>
+<p class="firstline">Returns the targetPools Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.targetSslProxies.html">targetSslProxies()</a></code>
+</p>
+<p class="firstline">Returns the targetSslProxies Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.targetVpnGateways.html">targetVpnGateways()</a></code>
+</p>
+<p class="firstline">Returns the targetVpnGateways Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.urlMaps.html">urlMaps()</a></code>
+</p>
+<p class="firstline">Returns the urlMaps Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.vpnTunnels.html">vpnTunnels()</a></code>
+</p>
+<p class="firstline">Returns the vpnTunnels Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.zoneOperations.html">zoneOperations()</a></code>
+</p>
+<p class="firstline">Returns the zoneOperations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="compute_beta.zones.html">zones()</a></code>
+</p>
+<p class="firstline">Returns the zones Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.httpHealthChecks.html b/docs/dyn/compute_beta.httpHealthChecks.html
new file mode 100644
index 0000000..22298ff
--- /dev/null
+++ b/docs/dyn/compute_beta.httpHealthChecks.html
@@ -0,0 +1,510 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.httpHealthChecks.html">httpHealthChecks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, httpHealthCheck)</a></code></p>
+<p class="firstline">Deletes the specified HttpHealthCheck resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, httpHealthCheck)</a></code></p>
+<p class="firstline">Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a HttpHealthCheck resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of HttpHealthCheck 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, 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, httpHealthCheck, body)</a></code></p>
+<p class="firstline">Updates a HttpHealthCheck resource in the specified project using the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, httpHealthCheck)</code>
+ <pre>Deletes the specified HttpHealthCheck resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ httpHealthCheck: string, Name of the HttpHealthCheck resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, httpHealthCheck)</code>
+ <pre>Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
+ "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a HttpHealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
+ "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of HttpHealthCheck resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of HttpHealthCheck resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of HttpHealthCheck resources.
+ { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
+ "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#httpHealthCheckList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, 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, Project ID for 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 instances should be checked for health, via HTTP.
+ "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, httpHealthCheck, body)</code>
+ <pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for 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 instances should be checked for health, via HTTP.
+ "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
+ "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 instance 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 instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.httpsHealthChecks.html b/docs/dyn/compute_beta.httpsHealthChecks.html
new file mode 100644
index 0000000..47edcb7
--- /dev/null
+++ b/docs/dyn/compute_beta.httpsHealthChecks.html
@@ -0,0 +1,510 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.httpsHealthChecks.html">httpsHealthChecks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, httpsHealthCheck)</a></code></p>
+<p class="firstline">Deletes the specified HttpsHealthCheck resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, httpsHealthCheck)</a></code></p>
+<p class="firstline">Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a HttpsHealthCheck resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of HttpsHealthCheck 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, httpsHealthCheck, body)</a></code></p>
+<p class="firstline">Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, httpsHealthCheck, body)</a></code></p>
+<p class="firstline">Updates a HttpsHealthCheck resource in the specified project using the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, httpsHealthCheck)</code>
+ <pre>Deletes the specified HttpsHealthCheck resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ httpsHealthCheck: string, Name of the HttpsHealthCheck resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, httpsHealthCheck)</code>
+ <pre>Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ httpsHealthCheck: string, Name of the HttpsHealthCheck resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+ "kind": "compute#httpsHealthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+ "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 HTTPS health check request. The default value is 443.
+ "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+ "kind": "compute#httpsHealthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+ "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 HTTPS health check request. The default value is 443.
+ "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of HttpsHealthCheck resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of HttpsHealthCheck resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of HttpsHealthCheck resources.
+ { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+ "kind": "compute#httpsHealthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+ "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 HTTPS health check request. The default value is 443.
+ "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#httpsHealthCheckList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, httpsHealthCheck, body)</code>
+ <pre>Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+ "kind": "compute#httpsHealthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+ "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 HTTPS health check request. The default value is 443.
+ "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, httpsHealthCheck, body)</code>
+ <pre>Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+ "kind": "compute#httpsHealthCheck", # Type of the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+ "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 HTTPS health check request. The default value is 443.
+ "healthyThreshold": 42, # A so-far unhealthy instance 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 HTTPS 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 HTTPS health check request. The default value is "/".
+ "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.images.html b/docs/dyn/compute_beta.images.html
new file mode 100644
index 0000000..f2c5997
--- /dev/null
+++ b/docs/dyn/compute_beta.images.html
@@ -0,0 +1,746 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.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.</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.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, image)</a></code></p>
+<p class="firstline">Returns the specified image. Get a list of available images by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#getFromFamily">getFromFamily(project, family)</a></code></p>
+<p class="firstline">Returns the latest image that is part of an image family and is not deprecated.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates an image in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.</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="#setLabels">setLabels(project, resource, body)</a></code></p>
+<p class="firstline">Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, image)</code>
+ <pre>Deletes the specified image.
+
+Args:
+ project: string, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="deprecate">deprecate(project, image, body)</code>
+ <pre>Sets the deprecation status of an image.
+
+If an empty request body is given, clears the deprecation status instead.
+
+Args:
+ project: string, Project ID for 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, image)</code>
+ <pre>Returns the specified image. Get a list of available images by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ image: string, Name of the image resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Image resource.
+ "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
+ # - zones/zone/disks/disk
+ "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
+ "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
+ "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an image.
+ "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
+ "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
+ "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
+ { # Guest OS features.
+ "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
+ },
+ ],
+ "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
+ "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
+ #
+ # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "rawDisk": { # The parameters of the raw disk image.
+ "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
+ "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
+ },
+ "licenses": [ # Any applicable license URI.
+ "A String",
+ ],
+ "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getFromFamily">getFromFamily(project, family)</code>
+ <pre>Returns the latest image that is part of an image family and is not deprecated.
+
+Args:
+ project: string, Project ID for this request. (required)
+ family: string, Name of the image family to search for. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Image resource.
+ "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
+ # - zones/zone/disks/disk
+ "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
+ "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
+ "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an image.
+ "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
+ "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
+ "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
+ { # Guest OS features.
+ "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
+ },
+ ],
+ "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
+ "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
+ #
+ # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "rawDisk": { # The parameters of the raw disk image.
+ "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
+ "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
+ },
+ "licenses": [ # Any applicable license URI.
+ "A String",
+ ],
+ "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates an image in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Image resource.
+ "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
+ # - zones/zone/disks/disk
+ "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
+ "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
+ "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an image.
+ "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
+ "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
+ "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
+ { # Guest OS features.
+ "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
+ },
+ ],
+ "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
+ "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
+ #
+ # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "rawDisk": { # The parameters of the raw disk image.
+ "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
+ "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
+ },
+ "licenses": [ # Any applicable license URI.
+ "A String",
+ ],
+ "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of images.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Image resources.
+ { # An Image resource.
+ "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
+ # - zones/zone/disks/disk
+ "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
+ "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
+ "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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve an image.
+ "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
+ "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
+ "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature is supported, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
+ { # Guest OS features.
+ "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported.
+ },
+ ],
+ "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
+ "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
+ #
+ # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "rawDisk": { # The parameters of the raw disk image.
+ "containerType": "A String", # The format used to encode and transmit the block device, which 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. You must provide either this property or the sourceDisk property but not both.
+ "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
+ },
+ "licenses": [ # Any applicable license URI.
+ "A String",
+ ],
+ "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#imageList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="setLabels">setLabels(project, resource, body)</code>
+ <pre>Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.
+ "labels": { # A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
+ "a_key": "A String",
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html
new file mode 100644
index 0000000..8c93a0e
--- /dev/null
+++ b/docs/dyn/compute_beta.instanceGroupManagers.html
@@ -0,0 +1,1168 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.instanceGroupManagers.html">instanceGroupManagers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of managed instance groups and groups them by zone.</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, zone, instanceGroupManager)</a></code></p>
+<p class="firstline">Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.</p>
+<p class="toc_element">
+ <code><a href="#deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, zone, instanceGroupManager)</a></code></p>
+<p class="firstline">Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, zone, body)</a></code></p>
+<p class="firstline">Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of managed instance groups that are contained within the specified project and zone.</p>
+<p class="toc_element">
+ <code><a href="#listManagedInstances">listManagedInstances(project, zone, instanceGroupManager)</a></code></p>
+<p class="firstline">Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.</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="#recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#resize">resize(project, zone, instanceGroupManager, size)</a></code></p>
+<p class="firstline">Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#resizeAdvanced">resizeAdvanced(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.</p>
+<p class="toc_element">
+ <code><a href="#setAutoHealingPolicies">setAutoHealingPolicies(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Modifies the autohealing policies.</p>
+<p class="toc_element">
+ <code><a href="#setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.</p>
+<p class="toc_element">
+ <code><a href="#setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</code>
+ <pre>Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The URL for one or more instances to abandon from the managed instance group.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of managed instance groups and groups them by zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of filtered managed instance group lists.
+ "a_key": { # [Output Only] The name of the scope that contains this set of managed instance groups.
+ "warning": { # [Output Only] The warning that replaces the list of managed instance groups when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "instanceGroupManagers": [ # [Output Only] The list of managed instance groups that are contained in the specified project and zone.
+ { # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ },
+ ],
+ },
+ },
+ "kind": "compute#instanceGroupManagerAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.
+ "id": "A String", # [Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
+ }</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, zone, instanceGroupManager)</code>
+ <pre>Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</code>
+ <pre>Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The list of instances to delete from this managed instance group. Specify one or more instance URLs.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, zone, instanceGroupManager)</code>
+ <pre>Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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)</code>
+ <pre>Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where you want to create the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of managed instance groups that are contained within the specified project and zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # [Output Only] A list of managed instance groups.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of managed instance groups.
+ { # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ },
+ ],
+ "kind": "compute#instanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listManagedInstances">listManagedInstances(project, zone, instanceGroupManager)</code>
+ <pre>Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "managedInstances": [ # [Output Only] The list of instances in the managed instance group.
+ {
+ "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
+ # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
+ # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
+ # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
+ # - RECREATING The managed instance group is recreating this instance.
+ # - DELETING The managed instance group is permanently deleting this instance.
+ # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
+ # - RESTARTING The managed instance group is restarting the instance.
+ # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
+ "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
+ "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
+ "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ },
+ "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
+ "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
+ },
+ ],
+ }</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="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</code>
+ <pre>Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The URL for one or more instances to recreate.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resize">resize(project, zone, instanceGroupManager, size)</code>
+ <pre>Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ size: integer, The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resizeAdvanced">resizeAdvanced(project, zone, instanceGroupManager, body)</code>
+ <pre>Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.
+
+If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "noCreationRetries": True or False, # If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attemps to recreate each instance continuously until it succeeds.
+ #
+ # This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario.
+ #
+ # This flag is applicable only to the current resize request. It does not influence other resize requests in any way.
+ #
+ # You can see which instances is being creating in which mode by calling the get or listManagedInstances API.
+ "targetSize": 42, # The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, zone, instanceGroupManager, body)</code>
+ <pre>Modifies the autohealing policies.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the instance group manager. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "autoHealingPolicies": [
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</code>
+ <pre>Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</code>
+ <pre>Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the managed instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "targetPools": [ # The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.
+ "A String",
+ ],
+ "fingerprint": "A String", # The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.instanceGroups.html b/docs/dyn/compute_beta.instanceGroups.html
new file mode 100644
index 0000000..a604006
--- /dev/null
+++ b/docs/dyn/compute_beta.instanceGroups.html
@@ -0,0 +1,773 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.instanceGroups.html">instanceGroups</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#addInstances">addInstances(project, zone, instanceGroup, body)</a></code></p>
+<p class="firstline">Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.</p>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of instance groups and sorts them by zone.</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, zone, instanceGroup)</a></code></p>
+<p class="firstline">Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, zone, instanceGroup)</a></code></p>
+<p class="firstline">Returns the specified instance group. Get a list of available instance groups by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, zone, body)</a></code></p>
+<p class="firstline">Creates an instance group in the specified project using the parameters that are included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of instance groups that are located in the specified project and zone.</p>
+<p class="toc_element">
+ <code><a href="#listInstances">listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Lists the instances in the specified instance group.</p>
+<p class="toc_element">
+ <code><a href="#listInstances_next">listInstances_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="#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="#removeInstances">removeInstances(project, zone, instanceGroup, body)</a></code></p>
+<p class="firstline">Removes one or more instances from the specified instance group, but does not delete those instances.</p>
+<p class="toc_element">
+ <code><a href="#setNamedPorts">setNamedPorts(project, zone, instanceGroup, body)</a></code></p>
+<p class="firstline">Sets the named ports for the specified instance group.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="addInstances">addInstances(project, zone, instanceGroup, body)</code>
+ <pre>Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ instanceGroup: string, The name of the instance group where you are adding instances. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The list of instances to add to the instance group.
+ {
+ "instance": "A String", # The URL for a specific instance.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of instance groups and sorts them by zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # A map of scoped instance group lists.
+ "a_key": { # The name of the scope that contains this set of instance groups.
+ "warning": { # [Output Only] An informational warning that replaces the list of instance groups when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "instanceGroups": [ # [Output Only] The list of instance groups that are contained in this scope.
+ {
+ "size": 42, # [Output Only] The total number of instances in the instance group.
+ "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
+ "network": "A String", # The URL of the network to which all instances in the instance group belong.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+ "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+ "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+ #
+ # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+ #
+ # Named ports apply to all instances in this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
+ "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
+ "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ },
+ ],
+ },
+ },
+ "kind": "compute#instanceGroupAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.
+ "id": "A String", # [Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
+ }</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, zone, instanceGroup)</code>
+ <pre>Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ instanceGroup: string, The name of the instance group to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, zone, instanceGroup)</code>
+ <pre>Returns the specified instance group. Get a list of available instance groups by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ instanceGroup: string, The name of the instance group. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "size": 42, # [Output Only] The total number of instances in the instance group.
+ "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
+ "network": "A String", # The URL of the network to which all instances in the instance group belong.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+ "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+ "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+ #
+ # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+ #
+ # Named ports apply to all instances in this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
+ "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
+ "name": "A String", # The name of the instance group. 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)</code>
+ <pre>Creates an instance group in the specified project using the parameters that are included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where you want to create the instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "size": 42, # [Output Only] The total number of instances in the instance group.
+ "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
+ "network": "A String", # The URL of the network to which all instances in the instance group belong.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+ "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+ "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+ #
+ # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+ #
+ # Named ports apply to all instances in this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
+ "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
+ "name": "A String", # The name of the instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of instance groups that are located in the specified project and zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # A list of InstanceGroup resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of instance groups.
+ {
+ "size": 42, # [Output Only] The total number of instances in the instance group.
+ "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
+ "network": "A String", # The URL of the network to which all instances in the instance group belong.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+ "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+ "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+ #
+ # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+ #
+ # Named ports apply to all instances in this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
+ "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
+ "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ },
+ ],
+ "kind": "compute#instanceGroupList", # [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.
+ "id": "A String", # [Output Only] A unique identifier for this list of instance groups. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listInstances">listInstances(project, zone, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Lists the instances in the specified instance group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ instanceGroup: string, The name of the instance group from which you want to generate a list of included instances. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instanceState": "A String", # A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.
+ }
+
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of instances and any named ports that are assigned to those instances.
+ {
+ "status": "A String", # [Output Only] The status of the instance.
+ "instance": "A String", # [Output Only] The URL of the instance.
+ "namedPorts": [ # [Output Only] The named ports that belong to this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ },
+ ],
+ "kind": "compute#instanceGroupsListInstances", # [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.
+ "id": "A String", # [Output Only] A unique identifier for this list of instances in the specified instance group. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this list of instances in the specified instance groups. The server generates this URL.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listInstances_next">listInstances_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="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="removeInstances">removeInstances(project, zone, instanceGroup, body)</code>
+ <pre>Removes one or more instances from the specified instance group, but does not delete those instances.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ instanceGroup: string, The name of the instance group where the specified instances will be removed. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The list of instances to remove from the instance group.
+ {
+ "instance": "A String", # The URL for a specific instance.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setNamedPorts">setNamedPorts(project, zone, instanceGroup, body)</code>
+ <pre>Sets the named ports for the specified instance group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone where the instance group is located. (required)
+ instanceGroup: string, The name of the instance group where the named ports are updated. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "namedPorts": [ # The list of named ports to set for this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.instanceTemplates.html b/docs/dyn/compute_beta.instanceTemplates.html
new file mode 100644
index 0000000..1212738
--- /dev/null
+++ b/docs/dyn/compute_beta.instanceTemplates.html
@@ -0,0 +1,767 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.instanceTemplates.html">instanceTemplates</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, instanceTemplate)</a></code></p>
+<p class="firstline">Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, instanceTemplate)</a></code></p>
+<p class="firstline">Returns the specified instance template. Get a list of available instance templates by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of instance templates that are contained within the specified project and 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, instanceTemplate)</code>
+ <pre>Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ instanceTemplate: string, The name of the instance template to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, instanceTemplate)</code>
+ <pre>Returns the specified instance template. Get a list of available instance templates by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ instanceTemplate: string, The name of the instance template. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Instance Template resource.
+ "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
+ "properties": { # The instance properties for this instance template.
+ "disks": [ # An array of disks that are associated with the instances that are created from this template.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "machineType": "A String", # The machine type to use for instances that are created from this template.
+ "description": "A String", # An optional text description for the instances that are created from this instance template.
+ "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labels": { # Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
+ "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "networkInterfaces": [ # An array of network access configurations for this interface.
+ { # A network interface resource attached to an instance.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ "name": "A String", # Name of this access configuration.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ },
+ "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Instance Template resource.
+ "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
+ "properties": { # The instance properties for this instance template.
+ "disks": [ # An array of disks that are associated with the instances that are created from this template.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "machineType": "A String", # The machine type to use for instances that are created from this template.
+ "description": "A String", # An optional text description for the instances that are created from this instance template.
+ "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labels": { # Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
+ "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "networkInterfaces": [ # An array of network access configurations for this interface.
+ { # A network interface resource attached to an instance.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ "name": "A String", # Name of this access configuration.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ },
+ "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of instance templates that are contained within the specified project and zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # A list of instance templates.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] list of InstanceTemplate resources.
+ { # An Instance Template resource.
+ "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
+ "properties": { # The instance properties for this instance template.
+ "disks": [ # An array of disks that are associated with the instances that are created from this template.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "machineType": "A String", # The machine type to use for instances that are created from this template.
+ "description": "A String", # An optional text description for the instances that are created from this instance template.
+ "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labels": { # Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
+ "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "networkInterfaces": [ # An array of network access configurations for this interface.
+ { # A network interface resource attached to an instance.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ "name": "A String", # Name of this access configuration.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ },
+ "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#instanceTemplateList", # [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.
+ "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this instance template list. The server defines this URL.
+ }</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="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html
new file mode 100644
index 0000000..9d6834e
--- /dev/null
+++ b/docs/dyn/compute_beta.instances.html
@@ -0,0 +1,2126 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.instances.html">instances</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</a></code></p>
+<p class="firstline">Adds an access config to an instance's network interface.</p>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves aggregated list of instances.</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="#attachDisk">attachDisk(project, zone, instance, body)</a></code></p>
+<p class="firstline">Attaches a Disk resource to an instance.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, zone, instance)</a></code></p>
+<p class="firstline">Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.</p>
+<p class="toc_element">
+ <code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</a></code></p>
+<p class="firstline">Deletes an access config from an instance's network interface.</p>
+<p class="toc_element">
+ <code><a href="#detachDisk">detachDisk(project, zone, instance, deviceName)</a></code></p>
+<p class="firstline">Detaches a disk from an instance.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, zone, instance)</a></code></p>
+<p class="firstline">Returns the specified Instance resource. Get a list of available instances by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, start=None, port=None)</a></code></p>
+<p class="firstline">Returns the specified instance's serial port output.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, zone, body)</a></code></p>
+<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of instances 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>
+<p class="toc_element">
+ <code><a href="#reset">reset(project, zone, instance)</a></code></p>
+<p class="firstline">Performs a hard reset on the instance.</p>
+<p class="toc_element">
+ <code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</a></code></p>
+<p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p>
+<p class="toc_element">
+ <code><a href="#setLabels">setLabels(project, zone, instance, body)</a></code></p>
+<p class="firstline">Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.</p>
+<p class="toc_element">
+ <code><a href="#setMachineType">setMachineType(project, zone, instance, body)</a></code></p>
+<p class="firstline">Changes the machine type for a stopped instance to the machine type specified in the request.</p>
+<p class="toc_element">
+ <code><a href="#setMetadata">setMetadata(project, zone, instance, body)</a></code></p>
+<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#setScheduling">setScheduling(project, zone, instance, body)</a></code></p>
+<p class="firstline">Sets an instance's scheduling options.</p>
+<p class="toc_element">
+ <code><a href="#setTags">setTags(project, zone, instance, body)</a></code></p>
+<p class="firstline">Sets tags for the specified instance to the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#start">start(project, zone, instance)</a></code></p>
+<p class="firstline">Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.</p>
+<p class="toc_element">
+ <code><a href="#startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body)</a></code></p>
+<p class="firstline">Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.</p>
+<p class="toc_element">
+ <code><a href="#stop">stop(project, zone, instance)</a></code></p>
+<p class="firstline">Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</code>
+ <pre>Adds an access config to an instance's network interface.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name for this request. (required)
+ networkInterface: string, The name of the network interface to add to this instance. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ "name": "A String", # Name of this access configuration.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves aggregated list of instances.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped instance lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of instances.
+ "instances": [ # [Output Only] List of instances contained in this scope.
+ { # An Instance resource.
+ "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
+ "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
+ "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance resides.
+ "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
+ #
+ # zones/us-central1-f/machineTypes/n1-standard-1
+ #
+ # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
+ #
+ # zones/zone/machineTypes/custom-CPUS-MEMORY
+ #
+ # For example: zones/us-central1-f/machineTypes/custom-4-5120
+ #
+ # For a full list of restrictions, read the Specifications for custom machine types.
+ "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
+ { # A network interface resource attached to an instance.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ "name": "A String", # Name of this access configuration.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ },
+ ],
+ "warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="attachDisk">attachDisk(project, zone, instance, body)</code>
+ <pre>Attaches a Disk resource to an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, zone, instance)</code>
+ <pre>Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</code>
+ <pre>Deletes an access config from an instance's network interface.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name for this request. (required)
+ accessConfig: string, The name of the access config to delete. (required)
+ networkInterface: string, The name of the network interface. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName)</code>
+ <pre>Detaches a disk from an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Instance name. (required)
+ deviceName: string, Disk device name to detach. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, zone, instance)</code>
+ <pre>Returns the specified Instance resource. Get a list of available instances by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Instance resource.
+ "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
+ "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
+ "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance resides.
+ "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
+ #
+ # zones/us-central1-f/machineTypes/n1-standard-1
+ #
+ # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
+ #
+ # zones/zone/machineTypes/custom-CPUS-MEMORY
+ #
+ # For example: zones/us-central1-f/machineTypes/custom-4-5120
+ #
+ # For a full list of restrictions, read the Specifications for custom machine types.
+ "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
+ { # A network interface resource attached to an instance.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ "name": "A String", # Name of this access configuration.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, start=None, port=None)</code>
+ <pre>Returns the specified instance's serial port output.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance scoping this request. (required)
+ start: string, For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value that was returned in the previous call.
+ port: integer, Specifies which COM or serial port to retrieve data from.
+
+Returns:
+ An object of the form:
+
+ { # An instance's serial console output.
+ "start": "A String", # [Output Only] The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched.
+ "kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ "contents": "A String", # [Output Only] The contents of the console output.
+ "next": "A String", # [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, zone, body)</code>
+ <pre>Creates an instance resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Instance resource.
+ "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
+ "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
+ "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance resides.
+ "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
+ #
+ # zones/us-central1-f/machineTypes/n1-standard-1
+ #
+ # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
+ #
+ # zones/zone/machineTypes/custom-CPUS-MEMORY
+ #
+ # For example: zones/us-central1-f/machineTypes/custom-4-5120
+ #
+ # For a full list of restrictions, read the Specifications for custom machine types.
+ "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
+ { # A network interface resource attached to an instance.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ "name": "A String", # Name of this access configuration.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of instances contained within the specified zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of instances.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of instances.
+ { # An Instance resource.
+ "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
+ "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
+ "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
+ "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance resides.
+ "tags": { # A set of instance tags. # A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ },
+ "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
+ { # An instance-attached disk resource.
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
+ "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-8
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
+ #
+ # To create a disk with a private image that you created, specify the image name in the following format:
+ #
+ # global/images/my-private-image
+ #
+ # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ #
+ # global/images/family/my-private-family
+ "diskStorageType": "A String", # [Deprecated] Storage type of the disk.
+ },
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
+ },
+ ],
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
+ "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ },
+ "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
+ #
+ # zones/us-central1-f/machineTypes/n1-standard-1
+ #
+ # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
+ #
+ # zones/zone/machineTypes/custom-CPUS-MEMORY
+ #
+ # For example: zones/us-central1-f/machineTypes/custom-4-5120
+ #
+ # For a full list of restrictions, read the Specifications for custom machine types.
+ "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
+ { # A service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account.
+ },
+ ],
+ "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
+ { # A network interface resource attached to an instance.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ "name": "A String", # Name of this access configuration.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ },
+ ],
+ "networkIP": "A String", # An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
+ #
+ # global/networks/default
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ },
+ ],
+ "kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="reset">reset(project, zone, instance)</code>
+ <pre>Performs a hard reset on the instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance scoping this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</code>
+ <pre>Sets the auto-delete flag for a disk attached to an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name. (required)
+ autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
+ deviceName: string, The device name of the disk to modify. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setLabels">setLabels(project, zone, instance, body)</code>
+ <pre>Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance scoping this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "labelFingerprint": "A String", # Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.
+ "labels": { # A list of labels to apply for this instance. Changing instance labels will also change the instance tags.
+ #
+ # Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
+ "a_key": "A String",
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setMachineType">setMachineType(project, zone, instance, body)</code>
+ <pre>Changes the machine type for a stopped instance to the machine type specified in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance scoping this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "machineType": "A String", # Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setMetadata">setMetadata(project, zone, instance, body)</code>
+ <pre>Sets metadata for the specified instance to the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setScheduling">setScheduling(project, zone, instance, body)</code>
+ <pre>Sets an instance's scheduling options.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Instance name. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Sets the scheduling options for an Instance.
+ "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
+ "preemptible": True or False, # Whether the instance is preemptible.
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setTags">setTags(project, zone, instance, body)</code>
+ <pre>Sets tags for the specified instance to the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance scoping this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A set of instance tags.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="start">start(project, zone, instance)</code>
+ <pre>Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance resource to start. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body)</code>
+ <pre>Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance resource to start. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.
+ #
+ # In order to start the instance, the disk url and its corresponding key must be provided.
+ #
+ # If the disk is not protected with a customer-supplied encryption key it should not be specified.
+ {
+ "diskEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with the disk with a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="stop">stop(project, zone, instance)</code>
+ <pre>Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, Name of the instance resource to stop. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.licenses.html b/docs/dyn/compute_beta.licenses.html
new file mode 100644
index 0000000..718b76f
--- /dev/null
+++ b/docs/dyn/compute_beta.licenses.html
@@ -0,0 +1,100 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.licenses.html">licenses</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(project, license)</a></code></p>
+<p class="firstline">Returns the specified License resource. Get a list of available licenses by making a list() request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(project, license)</code>
+ <pre>Returns the specified License resource. Get a list of available licenses by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ license: string, Name of the License resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A license resource.
+ "chargesUseFee": True or False, # [Output Only] If true, the customer will be charged license fee for running software that contains this license on an instance.
+ "kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses.
+ "name": "A String", # [Output Only] Name of the resource. The name is 1-63 characters long and complies with RFC1035.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.machineTypes.html b/docs/dyn/compute_beta.machineTypes.html
new file mode 100644
index 0000000..decdd48
--- /dev/null
+++ b/docs/dyn/compute_beta.machineTypes.html
@@ -0,0 +1,286 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.machineTypes.html">machineTypes</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of machine types.</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. Get a list of available machine types by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of machine types 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, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of machine types.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped machine type lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of machine types.
+ "machineTypes": [ # [Output Only] List of machine types contained in this scope.
+ { # A Machine Type resource.
+ "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
+ "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
+ "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
+ "description": "A String", # [Output Only] An optional textual description of the resource.
+ "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
+ "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
+ "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ "warning": { # [Output Only] An informational warning that appears when the machine types list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#machineTypeAggregatedList", # [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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. Get a list of available machine types by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ machineType: string, Name of the machine type to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Machine Type resource.
+ "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
+ "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
+ "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
+ "description": "A String", # [Output Only] An optional textual description of the resource.
+ "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
+ "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
+ "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of machine types available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of machine types.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Machine Type resources.
+ { # A Machine Type resource.
+ "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
+ "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
+ "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
+ "description": "A String", # [Output Only] An optional textual description of the resource.
+ "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
+ "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
+ "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ "kind": "compute#machineTypeList", # [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.networks.html b/docs/dyn/compute_beta.networks.html
new file mode 100644
index 0000000..b04bd48
--- /dev/null
+++ b/docs/dyn/compute_beta.networks.html
@@ -0,0 +1,414 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.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.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, network)</a></code></p>
+<p class="firstline">Returns the specified network. Get a list of available networks by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a network in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of networks 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="#switchToCustomMode">switchToCustomMode(project, network)</a></code></p>
+<p class="firstline">Switches the network mode from auto subnet mode to custom subnet mode.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, network)</code>
+ <pre>Deletes the specified network.
+
+Args:
+ project: string, Project ID for this request. (required)
+ network: string, Name of the network to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, network)</code>
+ <pre>Returns the specified network. Get a list of available networks by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ network: string, Name of the network to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents a Network resource. Read Networks and Firewalls for more information.
+ "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
+ "A String",
+ ],
+ "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
+ #
+ # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
+ "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a network in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Network resource. Read Networks and Firewalls for more information.
+ "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
+ "A String",
+ ],
+ "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
+ #
+ # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
+ "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of networks available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of networks.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Network resources.
+ { # Represents a Network resource. Read Networks and Firewalls for more information.
+ "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
+ "A String",
+ ],
+ "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
+ #
+ # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
+ "IPv4Range": "A String", # 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", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#networkList", # [Output Only] Type of resource. Always compute#networkList for lists of networks.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="switchToCustomMode">switchToCustomMode(project, network)</code>
+ <pre>Switches the network mode from auto subnet mode to custom subnet mode.
+
+Args:
+ project: string, Project ID for this request. (required)
+ network: string, Name of the network to be updated. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.projects.html b/docs/dyn/compute_beta.projects.html
new file mode 100644
index 0000000..4dda76f
--- /dev/null
+++ b/docs/dyn/compute_beta.projects.html
@@ -0,0 +1,417 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.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="#moveDisk">moveDisk(project, body)</a></code></p>
+<p class="firstline">Moves a persistent disk from one zone to another.</p>
+<p class="toc_element">
+ <code><a href="#moveInstance">moveInstance(project, body)</a></code></p>
+<p class="firstline">Moves an instance and its attached persistent disks from one zone to another.</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>
+<p class="toc_element">
+ <code><a href="#setUsageExportBucket">setUsageExportBucket(project, body)</a></code></p>
+<p class="firstline">Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.</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, Project ID for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
+ "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
+ "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
+ "enabledFeatures": [ # Restricted features enabled for use on this project.
+ "A String",
+ ],
+ "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
+ "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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+ },
+ "quotas": [ # [Output Only] Quotas assigned to this project.
+ { # A quotas entry.
+ "usage": 3.14, # [Output Only] Current usage of this metric.
+ "metric": "A String", # [Output Only] Name of the quota metric.
+ "limit": 3.14, # [Output Only] Quota limit for this metric.
+ },
+ ],
+ "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
+ "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
+ "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
+ "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
+ },
+ "xpnProjectStatus": "A String", # [Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "description": "A String", # An optional textual description of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="moveDisk">moveDisk(project, body)</code>
+ <pre>Moves a persistent disk from one zone to another.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "targetDisk": "A String", # The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
+ # - zones/zone/disks/disk
+ "destinationZone": "A String", # The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
+ # - projects/project/zones/zone
+ # - zones/zone
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="moveInstance">moveInstance(project, body)</code>
+ <pre>Moves an instance and its attached persistent disks from one zone to another.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "targetInstance": "A String", # The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ # - zones/zone/instances/instance
+ "destinationZone": "A String", # The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
+ # - projects/project/zones/zone
+ # - zones/zone
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</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, Project ID for 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", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setUsageExportBucket">setUsageExportBucket(project, body)</code>
+ <pre>Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.
+ "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
+ "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.regionAutoscalers.html b/docs/dyn/compute_beta.regionAutoscalers.html
new file mode 100644
index 0000000..5f54f7e
--- /dev/null
+++ b/docs/dyn/compute_beta.regionAutoscalers.html
@@ -0,0 +1,687 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.regionAutoscalers.html">regionAutoscalers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, region, autoscaler)</a></code></p>
+<p class="firstline">Deletes the specified autoscaler.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, autoscaler)</a></code></p>
+<p class="firstline">Returns the specified autoscaler.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates an autoscaler in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of autoscalers 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>
+<p class="toc_element">
+ <code><a href="#patch">patch(project, region, autoscaler, body)</a></code></p>
+<p class="firstline">Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, region, body, autoscaler=None)</a></code></p>
+<p class="firstline">Updates an autoscaler in the specified project using the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, region, autoscaler)</code>
+ <pre>Deletes the specified autoscaler.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ autoscaler: string, Name of the autoscaler to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, autoscaler)</code>
+ <pre>Returns the specified autoscaler.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ autoscaler: string, Name of the autoscaler to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates an autoscaler in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for 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:
+
+{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of autoscalers contained within the specified region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of autoscalers.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # A list of autoscalers.
+ { # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#regionAutoscalerList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, region, autoscaler, body)</code>
+ <pre>Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ autoscaler: string, Name of the autoscaler to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, region, body, autoscaler=None)</code>
+ <pre>Updates an autoscaler in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for 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:
+
+{ # Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.
+ "status": "A String", # [Output Only] The status of the autoscaler configuration.
+ "kind": "compute#autoscaler", # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
+ "region": "A String", # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
+ "autoscalingPolicy": { # Cloud Autoscaler policy. # The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
+ #
+ # If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
+ "maxNumReplicas": 42, # The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
+ "coolDownPeriodSec": 42, # The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
+ #
+ # Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
+ "loadBalancingUtilization": { # Configuration parameters of autoscaling based on load balancing. # Configuration parameters of autoscaling based on load balancer.
+ "utilizationTarget": 3.14, # Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
+ },
+ "customMetricUtilizations": [ # Configuration parameters of autoscaling based on a custom metric.
+ { # Custom utilization metric policy.
+ "metric": "A String", # The identifier of the Stackdriver Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
+ #
+ # For example, the following is a valid metric:
+ # compute.googleapis.com/instance/network/received_bytes_count
+ # The following is not a valid metric because it does not increase or decrease based on usage:
+ # compute.googleapis.com/instance/cpu/reserved_cores
+ "utilizationTargetType": "A String", # Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
+ "utilizationTarget": 3.14, # Target value of the metric which autoscaler should maintain. Must be a positive value.
+ },
+ ],
+ "cpuUtilization": { # CPU utilization policy. # Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
+ "utilizationTarget": 3.14, # The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.
+ #
+ # If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
+ #
+ # If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
+ },
+ "minNumReplicas": 42, # The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
+ },
+ "target": "A String", # URL of the managed instance group that this autoscaler will scale.
+ "statusDetails": [ # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
+ {
+ "message": "A String", # The status message.
+ "type": "A String", # The type of error returned.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+ autoscaler: string, Name of the autoscaler to update.
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html
new file mode 100644
index 0000000..0420489
--- /dev/null
+++ b/docs/dyn/compute_beta.regionBackendServices.html
@@ -0,0 +1,852 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.regionBackendServices.html">regionBackendServices</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, region, backendService)</a></code></p>
+<p class="firstline">Deletes the specified regional BackendService resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, backendService)</a></code></p>
+<p class="firstline">Returns the specified regional BackendService resource.</p>
+<p class="toc_element">
+ <code><a href="#getHealth">getHealth(project, region, backendService, body)</a></code></p>
+<p class="firstline">Gets the most recent health check results for this regional BackendService.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of regional BackendService resources available to the specified project in the given 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>
+<p class="toc_element">
+ <code><a href="#patch">patch(project, region, backendService, body)</a></code></p>
+<p class="firstline">Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, region, backendService, body)</a></code></p>
+<p class="firstline">Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, region, backendService)</code>
+ <pre>Deletes the specified regional BackendService resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ backendService: string, Name of the BackendService resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, backendService)</code>
+ <pre>Returns the specified regional BackendService resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ backendService: string, Name of the BackendService resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "loadBalancingScheme": "A String",
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getHealth">getHealth(project, region, backendService, body)</code>
+ <pre>Gets the most recent health check results for this regional BackendService.
+
+Args:
+ project: string, A parameter (required)
+ region: string, Name of the region scoping this request. (required)
+ backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "group": "A String", # A URI referencing one of the instance groups listed in the backend service.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
+ "healthStatus": [
+ {
+ "instance": "A String", # URL of the instance resource.
+ "healthState": "A String", # Health state of the instance.
+ "ipAddress": "A String", # The IP address represented by this resource.
+ "port": 42, # The port on the instance.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.
+
+Args:
+ project: string, Project ID for 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 BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "loadBalancingScheme": "A String",
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of regional BackendService resources available to the specified project in the given region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of BackendService resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "items": [ # A list of BackendService resources.
+ { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "loadBalancingScheme": "A String",
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, region, backendService, body)</code>
+ <pre>Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ backendService: string, Name of the BackendService resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "loadBalancingScheme": "A String",
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, region, backendService, body)</code>
+ <pre>Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ backendService: string, Name of the BackendService resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
+ "connectionDraining": { # Message containing connection draining configuration.
+ "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
+ },
+ "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
+ "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+ #
+ # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
+ #
+ # For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
+ "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
+ "loadBalancingScheme": "A String",
+ "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
+ #
+ # This cannot be used for internal load balancing.
+ "backends": [ # The list of backends that serve this BackendService.
+ { # Message containing information of one individual backend.
+ "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
+ #
+ # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
+ #
+ # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
+ #
+ # This cannot be used for internal load balancing.
+ "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
+ #
+ # This cannot be used for internal load balancing.
+ "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
+ #
+ # This cannot be used for internal load balancing.
+ },
+ ],
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
+ "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
+ #
+ # When the load balancing scheme is INTERNAL, this field is not used.
+ "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+ #
+ # For internal load balancing, a URL to a HealthCheck resource must be specified instead.
+ "A String",
+ ],
+ "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
+ #
+ # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
+ #
+ # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
+ #
+ # When the protocol is UDP, this field is not used.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html
new file mode 100644
index 0000000..d481d29
--- /dev/null
+++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html
@@ -0,0 +1,1194 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.regionInstanceGroupManagers.html">regionInstanceGroupManagers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#abandonInstances">abandonInstances(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, region, instanceGroupManager)</a></code></p>
+<p class="firstline">Deletes the specified managed instance group and all of the instances in that group.</p>
+<p class="toc_element">
+ <code><a href="#deleteInstances">deleteInstances(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, instanceGroupManager)</a></code></p>
+<p class="firstline">Returns all of the details about the specified managed instance group.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of managed instance groups that are contained within the specified region.</p>
+<p class="toc_element">
+ <code><a href="#listManagedInstances">listManagedInstances(project, region, instanceGroupManager)</a></code></p>
+<p class="firstline">Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.</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, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#recreateInstances">recreateInstances(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#resize">resize(project, region, instanceGroupManager, size)</a></code></p>
+<p class="firstline">Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.</p>
+<p class="toc_element">
+ <code><a href="#setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Modifies the autohealing policy for the instances in this managed instance group.</p>
+<p class="toc_element">
+ <code><a href="#setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.</p>
+<p class="toc_element">
+ <code><a href="#setTargetPools">setTargetPools(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, region, instanceGroupManager, body)</a></code></p>
+<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="abandonInstances">abandonInstances(project, region, instanceGroupManager, body)</code>
+ <pre>Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The names of one or more instances to abandon.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, region, instanceGroupManager)</code>
+ <pre>Deletes the specified managed instance group and all of the instances in that group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="deleteInstances">deleteInstances(project, region, instanceGroupManager, body)</code>
+ <pre>Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The names of one or more instances to delete.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, instanceGroupManager)</code>
+ <pre>Returns all of the details about the specified managed instance group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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 a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for 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:
+
+{ # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of managed instance groups that are contained within the specified region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of managed instance groups.
+ "nextPageToken": "A String", # [Output only] A token used to continue a truncated list request.
+ "items": [ # A list of managed instance groups.
+ { # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ },
+ ],
+ "kind": "compute#regionInstanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output only] The URL for this resource type. The server generates this URL.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listManagedInstances">listManagedInstances(project, region, instanceGroupManager)</code>
+ <pre>Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "managedInstances": [ # List of managed instances.
+ {
+ "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
+ # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
+ # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
+ # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
+ # - RECREATING The managed instance group is recreating this instance.
+ # - DELETING The managed instance group is permanently deleting this instance.
+ # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
+ # - RESTARTING The managed instance group is restarting the instance.
+ # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
+ "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
+ "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
+ "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ },
+ "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
+ "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
+ },
+ ],
+ }</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, region, instanceGroupManager, body)</code>
+ <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, The name of the instance group manager. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body)</code>
+ <pre>Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # The URL for one or more instances to recreate.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resize">resize(project, region, instanceGroupManager, size)</code>
+ <pre>Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ size: integer, Number of instances that should exist in this instance group manager. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body)</code>
+ <pre>Modifies the autohealing policy for the instances in this managed instance group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "autoHealingPolicies": [
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body)</code>
+ <pre>Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body)</code>
+ <pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "targetPools": [ # The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "fingerprint": "A String", # Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, region, instanceGroupManager, body)</code>
+ <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, The name of the instance group manager. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An Instance Group Manager resource.
+ "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+ "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
+ "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
+ "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
+ "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
+ "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+ "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
+ "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
+ "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
+ },
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
+ {
+ "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
+ "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
+ },
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
+ "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
+ "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
+ "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+ "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+ "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+ "name": "A String", # The name of the managed instance group. 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.regionInstanceGroups.html b/docs/dyn/compute_beta.regionInstanceGroups.html
new file mode 100644
index 0000000..6710238
--- /dev/null
+++ b/docs/dyn/compute_beta.regionInstanceGroups.html
@@ -0,0 +1,382 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.regionInstanceGroups.html">regionInstanceGroups</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, instanceGroup)</a></code></p>
+<p class="firstline">Returns the specified instance group resource.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of instance group resources contained within the specified region.</p>
+<p class="toc_element">
+ <code><a href="#listInstances">listInstances(project, region, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.</p>
+<p class="toc_element">
+ <code><a href="#listInstances_next">listInstances_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="#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="#setNamedPorts">setNamedPorts(project, region, instanceGroup, body)</a></code></p>
+<p class="firstline">Sets the named ports for the specified regional instance group.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(project, region, instanceGroup)</code>
+ <pre>Returns the specified instance group resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroup: string, Name of the instance group resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "size": 42, # [Output Only] The total number of instances in the instance group.
+ "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
+ "network": "A String", # The URL of the network to which all instances in the instance group belong.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+ "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+ "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+ #
+ # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+ #
+ # Named ports apply to all instances in this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
+ "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
+ "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of instance group resources contained within the specified region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of InstanceGroup resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of InstanceGroup resources.
+ {
+ "size": 42, # [Output Only] The total number of instances in the instance group.
+ "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
+ "region": "A String", # The URL of the region where the instance group is located (for regional resources).
+ "network": "A String", # The URL of the network to which all instances in the instance group belong.
+ "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+ "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+ "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+ #
+ # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+ #
+ # Named ports apply to all instances in this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
+ "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
+ "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
+ "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
+ },
+ ],
+ "kind": "compute#regionInstanceGroupList", # The resource type.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listInstances">listInstances(project, region, instanceGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroup: string, Name of the regional instance group for which we want to list the instances. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "portName": "A String", # Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.
+ "instanceState": "A String", # Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.
+ }
+
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of instances and any named ports that are assigned to those instances.
+ {
+ "status": "A String", # [Output Only] The status of the instance.
+ "instance": "A String", # [Output Only] The URL of the instance.
+ "namedPorts": [ # [Output Only] The named ports that belong to this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ },
+ ],
+ "kind": "compute#regionInstanceGroupsListInstances", # The resource type.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listInstances_next">listInstances_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="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="setNamedPorts">setNamedPorts(project, region, instanceGroup, body)</code>
+ <pre>Sets the named ports for the specified regional instance group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroup: string, The name of the regional instance group where the named ports are updated. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "namedPorts": [ # The list of named ports to set for this instance group.
+ { # The named port. For example: .
+ "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.operations.html b/docs/dyn/compute_beta.regionOperations.html
similarity index 77%
copy from docs/dyn/serviceregistry_alpha.operations.html
copy to docs/dyn/compute_beta.regionOperations.html
index eec2283..d63320d 100644
--- a/docs/dyn/serviceregistry_alpha.operations.html
+++ b/docs/dyn/compute_beta.regionOperations.html
@@ -72,25 +72,40 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.operations.html">operations</a></h1>
+<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regionOperations.html">regionOperations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#get">get(project, operation)</a></code></p>
-<p class="firstline">Gets information about a specific operation.</p>
+ <code><a href="#delete">delete(project, region, operation)</a></code></p>
+<p class="firstline">Deletes the specified region-specific Operations resource.</p>
<p class="toc_element">
- <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists all operations for a project.</p>
+ <code><a href="#get">get(project, region, operation)</a></code></p>
+<p class="firstline">Retrieves the specified region-specific Operations resource.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a 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="get">get(project, operation)</code>
- <pre>Gets information about a specific operation.
+ <code class="details" id="delete">delete(project, region, operation)</code>
+ <pre>Deletes the specified region-specific Operations resource.
Args:
- project: string, The project ID for this request. (required)
- operation: string, The name of the operation for this request. (required)
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ operation: string, Name of the Operations 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 Operations resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ operation: string, Name of the Operations resource to return. (required)
Returns:
An object of the form:
@@ -124,7 +139,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -138,16 +153,17 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all operations for a project.
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of Operation resources contained within the specified region.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -161,16 +177,16 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
-The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "operations": [ # [Output Only] Operations contained in this list response.
+ { # Contains a list of Operation resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Operation resources.
{ # An Operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] Reserved for future use.
@@ -200,7 +216,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -214,9 +230,12 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
},
],
+ "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_beta.regions.html b/docs/dyn/compute_beta.regions.html
new file mode 100644
index 0000000..a64166b
--- /dev/null
+++ b/docs/dyn/compute_beta.regions.html
@@ -0,0 +1,202 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.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. Get a list of available regions by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, 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. Get a list of available regions by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Region resource.
+ "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
+ "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
+ "description": "A String", # [Output Only] Textual description of the resource.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "quotas": [ # [Output Only] Quotas assigned to this region.
+ { # A quotas entry.
+ "usage": 3.14, # [Output Only] Current usage of this metric.
+ "metric": "A String", # [Output Only] Name of the quota metric.
+ "limit": 3.14, # [Output Only] Quota limit for this metric.
+ },
+ ],
+ "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of region resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of region resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Region resources.
+ { # Region resource.
+ "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
+ "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
+ "description": "A String", # [Output Only] Textual description of the resource.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "quotas": [ # [Output Only] Quotas assigned to this region.
+ { # A quotas entry.
+ "usage": 3.14, # [Output Only] Current usage of this metric.
+ "metric": "A String", # [Output Only] Name of the quota metric.
+ "limit": 3.14, # [Output Only] Quota limit for this metric.
+ },
+ ],
+ "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ "kind": "compute#regionList", # [Output Only] Type of resource. Always compute#regionList for lists of regions.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.routers.html b/docs/dyn/compute_beta.routers.html
new file mode 100644
index 0000000..67e9b94
--- /dev/null
+++ b/docs/dyn/compute_beta.routers.html
@@ -0,0 +1,890 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.routers.html">routers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of routers.</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, router)</a></code></p>
+<p class="firstline">Deletes the specified Router resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, router)</a></code></p>
+<p class="firstline">Returns the specified Router resource. Get a list of available routers by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#getRouterStatus">getRouterStatus(project, region, router)</a></code></p>
+<p class="firstline">Retrieves runtime information of the specified router.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a Router resource in the specified project and region using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of Router 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, region, router, body)</a></code></p>
+<p class="firstline">Updates the specified Router resource with the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#preview">preview(project, region, router, body)</a></code></p>
+<p class="firstline">Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, region, router, body)</a></code></p>
+<p class="firstline">Updates the specified Router resource with the data included in the request.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of routers.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of routers.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # A map of scoped router lists.
+ "a_key": { # Name of the scope containing this set of routers.
+ "routers": [ # List of routers contained in this scope.
+ { # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "warning": { # Informational warning which replaces the list of routers when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#routerAggregatedList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, router)</code>
+ <pre>Deletes the specified Router resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, router)</code>
+ <pre>Returns the specified Router resource. Get a list of available routers by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getRouterStatus">getRouterStatus(project, region, router)</code>
+ <pre>Retrieves runtime information of the specified router.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to query. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "compute#routerStatusResponse", # Type of resource.
+ "result": {
+ "bgpPeerStatus": [
+ {
+ "status": "A String", # Status of the BGP peer: {UP, DOWN}
+ "uptime": "A String", # Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
+ "name": "A String", # Name of this BGP peer. Unique within the Routers resource.
+ "uptimeSeconds": "A String", # Time this session has been up, in seconds. Format: 145
+ "linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls.
+ "peerIpAddress": "A String", # IP address of the remote BGP interface.
+ "advertisedRoutes": [ # Routes that were advertised to the remote BGP peer
+ { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+ #
+ # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+ #
+ # Packets that do not match any route in the sending instance's routing table are dropped.
+ "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
+ "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "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. You can specify this as a full or partial URL. For example:
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
+ "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # Fully-qualified URL of the network that this route applies to.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "destRange": "A String", # The destination range of outgoing packets that this route applies to.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ },
+ ],
+ "state": "A String", # BGP state as specified in RFC1771.
+ "ipAddress": "A String", # IP address of the local BGP interface.
+ "numLearnedRoutes": 42, # Number of routes learned from the remote BGP Peer.
+ },
+ ],
+ "network": "A String", # URI of the network to which this router belongs.
+ "bestRoutes": [ # Best routes for this router's network.
+ { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+ #
+ # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+ #
+ # Packets that do not match any route in the sending instance's routing table are dropped.
+ "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
+ "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "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. You can specify this as a full or partial URL. For example:
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
+ "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # Fully-qualified URL of the network that this route applies to.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "destRange": "A String", # The destination range of outgoing packets that this route applies to.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a Router resource in the specified project and region using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of Router resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of Router resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of Router resources.
+ { # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#routerList", # [Output Only] Type of resource. Always compute#router for routers.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, region, router, body)</code>
+ <pre>Updates the specified Router resource with the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="preview">preview(project, region, router, body)</code>
+ <pre>Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to query. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "resource": { # Router resource. # Preview of given router.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, region, router, body)</code>
+ <pre>Updates the specified Router resource with the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Router resource.
+ "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
+ {
+ "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
+ "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
+ "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "bgp": { # BGP information specific to this router.
+ "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
+ },
+ "network": "A String", # URI of the network to which this router belongs.
+ "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
+ {
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
+ },
+ ],
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.routes.html b/docs/dyn/compute_beta.routes.html
new file mode 100644
index 0000000..716a9c3
--- /dev/null
+++ b/docs/dyn/compute_beta.routes.html
@@ -0,0 +1,416 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.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. Get a list of available routes by making a list() request.</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, orderBy=None, 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</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, Project ID for 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", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, route)</code>
+ <pre>Returns the specified Route resource. Get a list of available routes by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ route: string, Name of the Route resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+ #
+ # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+ #
+ # Packets that do not match any route in the sending instance's routing table are dropped.
+ "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
+ "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "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. You can specify this as a full or partial URL. For example:
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
+ "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # Fully-qualified URL of the network that this route applies to.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "destRange": "A String", # The destination range of outgoing packets that this route applies to.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ }</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, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+ #
+ # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+ #
+ # Packets that do not match any route in the sending instance's routing table are dropped.
+ "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
+ "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "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. You can specify this as a full or partial URL. For example:
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
+ "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # Fully-qualified URL of the network that this route applies to.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "destRange": "A String", # The destination range of outgoing packets that this route applies to.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of Route resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of Route resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Route resources.
+ { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+ #
+ # For each packet leaving a instance, the system searches that instance'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 nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+ #
+ # Packets that do not match any route in the sending instance's routing table are dropped.
+ "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
+ "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
+ "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "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. You can specify this as a full or partial URL. For example:
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
+ "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
+ "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
+ "network": "A String", # Fully-qualified URL of the network that this route applies to.
+ "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+ "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "destRange": "A String", # The destination range of outgoing packets that this route applies to.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ },
+ ],
+ "kind": "compute#routeList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.snapshots.html b/docs/dyn/compute_beta.snapshots.html
new file mode 100644
index 0000000..939724b
--- /dev/null
+++ b/docs/dyn/compute_beta.snapshots.html
@@ -0,0 +1,412 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.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 Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, snapshot)</a></code></p>
+<p class="firstline">Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of 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>
+<p class="toc_element">
+ <code><a href="#setLabels">setLabels(project, resource, body)</a></code></p>
+<p class="firstline">Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, snapshot)</code>
+ <pre>Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.
+
+For more information, see Deleting snaphots.
+
+Args:
+ project: string, Project ID for this request. (required)
+ snapshot: string, Name of the Snapshot resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, snapshot)</code>
+ <pre>Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ snapshot: string, Name of the Snapshot resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A persistent disk snapshot resource.
+ "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
+ "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
+ "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
+ #
+ # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a snapshot.
+ "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
+ "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of Snapshot resources contained within the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of Snapshot resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Snapshot resources.
+ { # A persistent disk snapshot resource.
+ "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
+ "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
+ "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
+ "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
+ #
+ # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
+ #
+ # Customer-supplied encryption keys do not protect access to metadata of the disk.
+ #
+ # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ },
+ "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
+ "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve a snapshot.
+ "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+ "a_key": "A String",
+ },
+ "sourceDiskId": "A String", # [Output Only] 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", # [Output Only] Size of the snapshot, specified in GB.
+ "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#snapshotList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="setLabels">setLabels(project, resource, body)</code>
+ <pre>Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.
+ "labels": { # A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
+ "a_key": "A String",
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.sslCertificates.html b/docs/dyn/compute_beta.sslCertificates.html
new file mode 100644
index 0000000..8802b04
--- /dev/null
+++ b/docs/dyn/compute_beta.sslCertificates.html
@@ -0,0 +1,335 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.sslCertificates.html">sslCertificates</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, sslCertificate)</a></code></p>
+<p class="firstline">Deletes the specified SslCertificate resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, sslCertificate)</a></code></p>
+<p class="firstline">Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a SslCertificate resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of SslCertificate 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="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, sslCertificate)</code>
+ <pre>Deletes the specified SslCertificate resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ sslCertificate: string, Name of the SslCertificate resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, sslCertificate)</code>
+ <pre>Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ sslCertificate: string, Name of the SslCertificate resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
+ "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
+ "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a SslCertificate resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
+ "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
+ "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of SslCertificate resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of SslCertificate resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of SslCertificate resources.
+ { # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
+ "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
+ "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ },
+ ],
+ "kind": "compute#sslCertificateList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.subnetworks.html b/docs/dyn/compute_beta.subnetworks.html
new file mode 100644
index 0000000..8190ee3
--- /dev/null
+++ b/docs/dyn/compute_beta.subnetworks.html
@@ -0,0 +1,498 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.subnetworks.html">subnetworks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of subnetworks.</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, subnetwork)</a></code></p>
+<p class="firstline">Deletes the specified subnetwork.</p>
+<p class="toc_element">
+ <code><a href="#expandIpCidrRange">expandIpCidrRange(project, region, subnetwork, body)</a></code></p>
+<p class="firstline">Expands the IP CIDR range of the subnetwork to a specified value.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, subnetwork)</a></code></p>
+<p class="firstline">Returns the specified subnetwork. Get a list of available subnetworks list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a subnetwork in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of subnetworks 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="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of subnetworks.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output] A map of scoped Subnetwork lists.
+ "a_key": { # Name of the scope containing this set of Subnetworks.
+ "subnetworks": [ # List of subnetworks contained in this scope.
+ { # A Subnetwork resource.
+ "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "region": "A String", # URL of the region where the Subnetwork resides.
+ "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
+ "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
+ "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "warning": { # An informational warning that appears when the list of addresses is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#subnetworkAggregatedList", # [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, subnetwork)</code>
+ <pre>Deletes the specified subnetwork.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ subnetwork: string, Name of the Subnetwork resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="expandIpCidrRange">expandIpCidrRange(project, region, subnetwork, body)</code>
+ <pre>Expands the IP CIDR range of the subnetwork to a specified value.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ subnetwork: string, Name of the Subnetwork resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "ipCidrRange": "A String", # The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, subnetwork)</code>
+ <pre>Returns the specified subnetwork. Get a list of available subnetworks list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ subnetwork: string, Name of the Subnetwork resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A Subnetwork resource.
+ "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "region": "A String", # URL of the region where the Subnetwork resides.
+ "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
+ "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
+ "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a subnetwork in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for 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 Subnetwork resource.
+ "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "region": "A String", # URL of the region where the Subnetwork resides.
+ "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
+ "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
+ "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of subnetworks available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of Subnetwork resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # The Subnetwork resources.
+ { # A Subnetwork resource.
+ "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "region": "A String", # URL of the region where the Subnetwork resides.
+ "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
+ "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
+ "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#subnetworkList", # [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.targetHttpProxies.html b/docs/dyn/compute_beta.targetHttpProxies.html
new file mode 100644
index 0000000..5afb30d
--- /dev/null
+++ b/docs/dyn/compute_beta.targetHttpProxies.html
@@ -0,0 +1,400 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.targetHttpProxies.html">targetHttpProxies</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, targetHttpProxy)</a></code></p>
+<p class="firstline">Deletes the specified TargetHttpProxy resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, targetHttpProxy)</a></code></p>
+<p class="firstline">Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a TargetHttpProxy resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of TargetHttpProxy 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="#setUrlMap">setUrlMap(project, targetHttpProxy, body)</a></code></p>
+<p class="firstline">Changes the URL map for TargetHttpProxy.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, targetHttpProxy)</code>
+ <pre>Deletes the specified TargetHttpProxy resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, targetHttpProxy)</code>
+ <pre>Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
+ "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a TargetHttpProxy resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A TargetHttpProxy resource. This resource defines an HTTP proxy.
+ "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of TargetHttpProxy resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # A list of TargetHttpProxy resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of TargetHttpProxy resources.
+ { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
+ "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="setUrlMap">setUrlMap(project, targetHttpProxy, body)</code>
+ <pre>Changes the URL map for TargetHttpProxy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "urlMap": "A String",
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.endpoints.html b/docs/dyn/compute_beta.targetHttpsProxies.html
similarity index 64%
copy from docs/dyn/serviceregistry_alpha.endpoints.html
copy to docs/dyn/compute_beta.targetHttpsProxies.html
index fb47c39..0a10a21 100644
--- a/docs/dyn/serviceregistry_alpha.endpoints.html
+++ b/docs/dyn/compute_beta.targetHttpsProxies.html
@@ -72,37 +72,40 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.endpoints.html">endpoints</a></h1>
+<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.targetHttpsProxies.html">targetHttpsProxies</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(project, endpoint)</a></code></p>
-<p class="firstline">Deletes an endpoint.</p>
+ <code><a href="#delete">delete(project, targetHttpsProxy)</a></code></p>
+<p class="firstline">Deletes the specified TargetHttpsProxy resource.</p>
<p class="toc_element">
- <code><a href="#get">get(project, endpoint)</a></code></p>
-<p class="firstline">Gets an endpoint.</p>
+ <code><a href="#get">get(project, targetHttpsProxy)</a></code></p>
+<p class="firstline">Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates an endpoint.</p>
+<p class="firstline">Creates a TargetHttpsProxy resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists endpoints for a project.</p>
+<p class="firstline">Retrieves the list of TargetHttpsProxy 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, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint. This method supports patch semantics.</p>
+ <code><a href="#setSslCertificates">setSslCertificates(project, targetHttpsProxy, body)</a></code></p>
+<p class="firstline">Replaces SslCertificates for TargetHttpsProxy.</p>
<p class="toc_element">
- <code><a href="#update">update(project, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint.</p>
+ <code><a href="#setUrlMap">setUrlMap(project, targetHttpsProxy, body)</a></code></p>
+<p class="firstline">Changes the URL map for TargetHttpsProxy.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(project, endpoint)</code>
- <pre>Deletes an endpoint.
+ <code class="details" id="delete">delete(project, targetHttpsProxy)</code>
+ <pre>Deletes the specified TargetHttpsProxy resource.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required)
Returns:
An object of the form:
@@ -136,7 +139,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -150,65 +153,61 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="get">get(project, endpoint)</code>
- <pre>Gets an endpoint.
+ <code class="details" id="get">get(project, targetHttpsProxy)</code>
+ <pre>Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required)
Returns:
An object of the form:
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
+ "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
+ "A String",
+ ],
+ "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
+ # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
+ # - projects/project/global/urlMaps/url-map
+ # - global/urlMaps/url-map
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, body)</code>
- <pre>Creates an endpoint.
+ <pre>Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+{ # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
+ "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
+ "A String",
+ ],
+ "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
+ # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
+ # - projects/project/global/urlMaps/url-map
+ # - global/urlMaps/url-map
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
@@ -244,7 +243,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -258,16 +257,16 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists endpoints for a project.
+ <pre>Retrieves the list of TargetHttpsProxy resources available to the specified project.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -281,34 +280,35 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
-The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 6
+ { # Contains a list of TargetHttpsProxy resources.
"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
- "endpoints": [ # The endpoints contained in this response.
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ "items": [ # A list of TargetHttpsProxy resources.
+ { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
+ "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
+ "A String",
+ ],
+ "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
+ # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
+ # - projects/project/global/urlMaps/url-map
+ # - global/urlMaps/url-map
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
+ "kind": "compute#targetHttpsProxyList", # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
@@ -327,31 +327,19 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, endpoint, body)</code>
- <pre>Updates an endpoint. This method supports patch semantics.
+ <code class="details" id="setSslCertificates">setSslCertificates(project, targetHttpsProxy, body)</code>
+ <pre>Replaces SslCertificates for TargetHttpsProxy.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+{
+ "sslCertificates": [ # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.
+ "A String",
+ ],
}
@@ -387,7 +375,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -401,36 +389,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="update">update(project, endpoint, body)</code>
- <pre>Updates an endpoint.
+ <code class="details" id="setUrlMap">setUrlMap(project, targetHttpsProxy, body)</code>
+ <pre>Changes the URL map for TargetHttpsProxy.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+{
+ "urlMap": "A String",
}
@@ -466,7 +440,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -480,7 +454,34 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
}</pre>
</div>
diff --git a/docs/dyn/compute_beta.targetInstances.html b/docs/dyn/compute_beta.targetInstances.html
new file mode 100644
index 0000000..ebf0ab1
--- /dev/null
+++ b/docs/dyn/compute_beta.targetInstances.html
@@ -0,0 +1,437 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.targetInstances.html">targetInstances</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of target instances.</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, zone, targetInstance)</a></code></p>
+<p class="firstline">Deletes the specified TargetInstance resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, zone, targetInstance)</a></code></p>
+<p class="firstline">Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, zone, body)</a></code></p>
+<p class="firstline">Creates a TargetInstance resource in the specified project and zone using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of TargetInstance resources available to the specified project and 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of target instances.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # A map of scoped target instance lists.
+ "a_key": { # Name of the scope containing this set of target instances.
+ "targetInstances": [ # List of target instances contained in this scope.
+ { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
+ "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
+ "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
+ "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ # - zones/zone/instances/instance
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "warning": { # Informational warning which replaces the list of addresses when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#targetInstanceAggregatedList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, zone, targetInstance)</code>
+ <pre>Deletes the specified TargetInstance resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone scoping this request. (required)
+ targetInstance: string, Name of the TargetInstance resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, zone, targetInstance)</code>
+ <pre>Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone scoping this request. (required)
+ targetInstance: string, Name of the TargetInstance resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
+ "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
+ "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
+ "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ # - zones/zone/instances/instance
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, zone, body)</code>
+ <pre>Creates a TargetInstance resource in the specified project and zone using the data included in the request.
+
+Args:
+ project: string, Project ID for 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 TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
+ "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
+ "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
+ "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ # - zones/zone/instances/instance
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of TargetInstance resources available to the specified project and zone.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of TargetInstance resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of TargetInstance resources.
+ { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
+ "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
+ "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
+ "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+ # - projects/project/zones/zone/instances/instance
+ # - zones/zone/instances/instance
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#targetInstanceList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.targetPools.html b/docs/dyn/compute_beta.targetPools.html
new file mode 100644
index 0000000..600684f
--- /dev/null
+++ b/docs/dyn/compute_beta.targetPools.html
@@ -0,0 +1,906 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.targetPools.html">targetPools</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#addHealthCheck">addHealthCheck(project, region, targetPool, body)</a></code></p>
+<p class="firstline">Adds health check URLs to a target pool.</p>
+<p class="toc_element">
+ <code><a href="#addInstance">addInstance(project, region, targetPool, body)</a></code></p>
+<p class="firstline">Adds an instance to a target pool.</p>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of target pools.</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, targetPool)</a></code></p>
+<p class="firstline">Deletes the specified target pool.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, targetPool)</a></code></p>
+<p class="firstline">Returns the specified target pool. Get a list of available target pools by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#getHealth">getHealth(project, region, targetPool, body)</a></code></p>
+<p class="firstline">Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a target pool in the specified project and region using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of target pools available to the specified project and 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>
+<p class="toc_element">
+ <code><a href="#removeHealthCheck">removeHealthCheck(project, region, targetPool, body)</a></code></p>
+<p class="firstline">Removes health check URL from a target pool.</p>
+<p class="toc_element">
+ <code><a href="#removeInstance">removeInstance(project, region, targetPool, body)</a></code></p>
+<p class="firstline">Removes instance URL from a target pool.</p>
+<p class="toc_element">
+ <code><a href="#setBackup">setBackup(project, region, targetPool, body, failoverRatio=None)</a></code></p>
+<p class="firstline">Changes a backup target pool's configurations.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="addHealthCheck">addHealthCheck(project, region, targetPool, body)</code>
+ <pre>Adds health check URLs to a target pool.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the target pool to add a health check to. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "healthChecks": [ # A list of HttpHealthCheck resources to add to the target pool.
+ { # A full or valid partial URL to a health check. For example, the following are valid URLs:
+ # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
+ # - projects/project-id/global/httpHealthChecks/health-check
+ # - global/httpHealthChecks/health-check
+ "healthCheck": "A String",
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="addInstance">addInstance(project, region, targetPool, body)</code>
+ <pre>Adds an instance to a target pool.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the TargetPool resource to add instances to. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
+ # - projects/project-id/zones/zone/instances/instance-name
+ # - zones/zone/instances/instance-name
+ {
+ "instance": "A String", # The URL for a specific instance.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of target pools.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped target pool lists.
+ "a_key": { # Name of the scope containing this set of target pools.
+ "warning": { # Informational warning which replaces the list of addresses when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "targetPools": [ # List of target pools contained in this scope.
+ { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
+ "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
+ #
+ # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the target pool resides.
+ "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
+ "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
+ # NONE: Connections from the same client IP may go to any instance in the pool.
+ # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
+ # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
+ "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
+ "A String",
+ ],
+ "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
+ #
+ # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ },
+ },
+ "kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, targetPool)</code>
+ <pre>Deletes the specified target pool.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the TargetPool resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, targetPool)</code>
+ <pre>Returns the specified target pool. Get a list of available target pools by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the TargetPool resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
+ "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
+ #
+ # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the target pool resides.
+ "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
+ "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
+ # NONE: Connections from the same client IP may go to any instance in the pool.
+ # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
+ # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
+ "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
+ "A String",
+ ],
+ "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
+ #
+ # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getHealth">getHealth(project, region, targetPool, body)</code>
+ <pre>Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instance": "A String", # The URL for a specific instance.
+}
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
+ "healthStatus": [
+ {
+ "instance": "A String", # URL of the instance resource.
+ "healthState": "A String", # Health state of the instance.
+ "ipAddress": "A String", # The IP address represented by this resource.
+ "port": 42, # The port on the instance.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a target pool in the specified project and region using the data included in the request.
+
+Args:
+ project: string, Project ID for 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 TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
+ "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
+ #
+ # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the target pool resides.
+ "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
+ "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
+ # NONE: Connections from the same client IP may go to any instance in the pool.
+ # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
+ # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
+ "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
+ "A String",
+ ],
+ "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
+ #
+ # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of target pools available to the specified project and region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of TargetPool resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of TargetPool resources.
+ { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
+ "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
+ #
+ # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "region": "A String", # [Output Only] URL of the region where the target pool resides.
+ "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
+ "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
+ # NONE: Connections from the same client IP may go to any instance in the pool.
+ # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
+ # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
+ "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
+ "A String",
+ ],
+ "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
+ #
+ # backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
+ #
+ # In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
+ "healthChecks": [ # A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
+ "A String",
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="removeHealthCheck">removeHealthCheck(project, region, targetPool, body)</code>
+ <pre>Removes health check URL from a target pool.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ targetPool: string, Name of the target pool to remove health checks from. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
+ # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
+ # - projects/project/global/httpHealthChecks/health-check
+ # - global/httpHealthChecks/health-check
+ { # A full or valid partial URL to a health check. For example, the following are valid URLs:
+ # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
+ # - projects/project-id/global/httpHealthChecks/health-check
+ # - global/httpHealthChecks/health-check
+ "healthCheck": "A String",
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="removeInstance">removeInstance(project, region, targetPool, body)</code>
+ <pre>Removes instance URL from a target pool.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the TargetPool resource to remove instances from. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "instances": [ # URLs of the instances to be removed from target pool.
+ {
+ "instance": "A String", # The URL for a specific instance.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setBackup">setBackup(project, region, targetPool, body, failoverRatio=None)</code>
+ <pre>Changes a backup target pool's configurations.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "target": "A String",
+ }
+
+ failoverRatio: number, New failoverRatio value for the target pool.
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.endpoints.html b/docs/dyn/compute_beta.targetSslProxies.html
similarity index 60%
copy from docs/dyn/serviceregistry_alpha.endpoints.html
copy to docs/dyn/compute_beta.targetSslProxies.html
index fb47c39..a6b2724 100644
--- a/docs/dyn/serviceregistry_alpha.endpoints.html
+++ b/docs/dyn/compute_beta.targetSslProxies.html
@@ -72,37 +72,43 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.endpoints.html">endpoints</a></h1>
+<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.targetSslProxies.html">targetSslProxies</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(project, endpoint)</a></code></p>
-<p class="firstline">Deletes an endpoint.</p>
+ <code><a href="#delete">delete(project, targetSslProxy)</a></code></p>
+<p class="firstline">Deletes the specified TargetSslProxy resource.</p>
<p class="toc_element">
- <code><a href="#get">get(project, endpoint)</a></code></p>
-<p class="firstline">Gets an endpoint.</p>
+ <code><a href="#get">get(project, targetSslProxy)</a></code></p>
+<p class="firstline">Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates an endpoint.</p>
+<p class="firstline">Creates a TargetSslProxy resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists endpoints for a project.</p>
+<p class="firstline">Retrieves the list of TargetSslProxy 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, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint. This method supports patch semantics.</p>
+ <code><a href="#setBackendService">setBackendService(project, targetSslProxy, body)</a></code></p>
+<p class="firstline">Changes the BackendService for TargetSslProxy.</p>
<p class="toc_element">
- <code><a href="#update">update(project, endpoint, body)</a></code></p>
-<p class="firstline">Updates an endpoint.</p>
+ <code><a href="#setProxyHeader">setProxyHeader(project, targetSslProxy, body)</a></code></p>
+<p class="firstline">Changes the ProxyHeaderType for TargetSslProxy.</p>
+<p class="toc_element">
+ <code><a href="#setSslCertificates">setSslCertificates(project, targetSslProxy, body)</a></code></p>
+<p class="firstline">Changes SslCertificates for TargetSslProxy.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(project, endpoint)</code>
- <pre>Deletes an endpoint.
+ <code class="details" id="delete">delete(project, targetSslProxy)</code>
+ <pre>Deletes the specified TargetSslProxy resource.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required)
Returns:
An object of the form:
@@ -136,7 +142,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -150,65 +156,57 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="get">get(project, endpoint)</code>
- <pre>Gets an endpoint.
+ <code class="details" id="get">get(project, targetSslProxy)</code>
+ <pre>Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource to return. (required)
Returns:
An object of the form:
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ { # A TargetSslProxy resource. This resource defines an SSL proxy.
+ "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "service": "A String", # URL to the BackendService resource.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
+ "A String",
+ ],
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, body)</code>
- <pre>Creates an endpoint.
+ <pre>Creates a TargetSslProxy resource in the specified project using the data included in the request.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+{ # A TargetSslProxy resource. This resource defines an SSL proxy.
+ "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "service": "A String", # URL to the BackendService resource.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
+ "A String",
+ ],
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
@@ -244,7 +242,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -258,16 +256,16 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists endpoints for a project.
+ <pre>Retrieves the list of TargetSslProxy resources available to the specified project.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -281,34 +279,33 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
-The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 6
+ { # Contains a list of TargetSslProxy resources.
"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
- "endpoints": [ # The endpoints contained in this response.
- { # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+ "items": [ # A list of TargetSslProxy resources.
+ { # A TargetSslProxy resource. This resource defines an SSL proxy.
+ "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "service": "A String", # URL to the BackendService resource.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
+ "A String",
+ ],
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
+ "kind": "compute#targetSslProxyList", # Type of resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
@@ -327,31 +324,17 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, endpoint, body)</code>
- <pre>Updates an endpoint. This method supports patch semantics.
+ <code class="details" id="setBackendService">setBackendService(project, targetSslProxy, body)</code>
+ <pre>Changes the BackendService for TargetSslProxy.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+{
+ "service": "A String", # The URL of the new BackendService resource for the targetSslProxy.
}
@@ -387,7 +370,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -401,36 +384,22 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="update">update(project, endpoint, body)</code>
- <pre>Updates an endpoint.
+ <code class="details" id="setProxyHeader">setProxyHeader(project, targetSslProxy, body)</code>
+ <pre>Changes the ProxyHeaderType for TargetSslProxy.
Args:
- project: string, The project ID for this request. (required)
- endpoint: string, The name of the endpoint for this request. (required)
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Next available tag: 13
- "description": "A String", # An optional user-provided description of the endpoint.
- "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
- "visibility": { # The DNS Integration configuration for this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
- "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
- "A String",
- ],
- "internalDnsName": "A String", # [Output Only] Fully qualified domain name for the endpoint; used when addressing the endpoint from within Compute Networks specified in the networks field.
- },
- "port": 42, # An optional user-provided port of the service represented by this endpoint.
- "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
- "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the endpoint.
- "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+{
+ "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
}
@@ -466,7 +435,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -480,7 +449,101 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setSslCertificates">setSslCertificates(project, targetSslProxy, body)</code>
+ <pre>Changes SslCertificates for TargetSslProxy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
}</pre>
</div>
diff --git a/docs/dyn/compute_beta.targetVpnGateways.html b/docs/dyn/compute_beta.targetVpnGateways.html
new file mode 100644
index 0000000..b883dcc
--- /dev/null
+++ b/docs/dyn/compute_beta.targetVpnGateways.html
@@ -0,0 +1,449 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.targetVpnGateways.html">targetVpnGateways</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of target VPN gateways.</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, targetVpnGateway)</a></code></p>
+<p class="firstline">Deletes the specified target VPN gateway.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, targetVpnGateway)</a></code></p>
+<p class="firstline">Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a target VPN gateway in the specified project and region using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of target VPN gateways available to the specified project and 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of target VPN gateways.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # A map of scoped target vpn gateway lists.
+ "a_key": { # [Output Only] Name of the scope containing this set of target VPN gateways.
+ "targetVpnGateways": [ # [Output Only] List of target vpn gateways contained in this scope.
+ { # Represents a Target VPN gateway resource.
+ "status": "A String", # [Output Only] The status of the VPN gateway.
+ "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
+ "A String",
+ ],
+ "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
+ "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
+ "A String",
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, targetVpnGateway)</code>
+ <pre>Deletes the specified target VPN gateway.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ targetVpnGateway: string, Name of the target VPN gateway to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, targetVpnGateway)</code>
+ <pre>Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ targetVpnGateway: string, Name of the target VPN gateway to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents a Target VPN gateway resource.
+ "status": "A String", # [Output Only] The status of the VPN gateway.
+ "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
+ "A String",
+ ],
+ "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
+ "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
+ "A String",
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a target VPN gateway in the specified project and region using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Target VPN gateway resource.
+ "status": "A String", # [Output Only] The status of the VPN gateway.
+ "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
+ "A String",
+ ],
+ "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
+ "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
+ "A String",
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of target VPN gateways available to the specified project and region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of TargetVpnGateway resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of TargetVpnGateway resources.
+ { # Represents a Target VPN gateway resource.
+ "status": "A String", # [Output Only] The status of the VPN gateway.
+ "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
+ "A String",
+ ],
+ "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
+ "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
+ "A String",
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.urlMaps.html b/docs/dyn/compute_beta.urlMaps.html
new file mode 100644
index 0000000..bfa777b
--- /dev/null
+++ b/docs/dyn/compute_beta.urlMaps.html
@@ -0,0 +1,812 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.urlMaps.html">urlMaps</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, urlMap)</a></code></p>
+<p class="firstline">Deletes the specified UrlMap resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, urlMap)</a></code></p>
+<p class="firstline">Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a UrlMap resource in the specified project using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#invalidateCache">invalidateCache(project, urlMap, body)</a></code></p>
+<p class="firstline">Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves the list of UrlMap 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, urlMap, body)</a></code></p>
+<p class="firstline">Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, urlMap, body)</a></code></p>
+<p class="firstline">Updates the specified UrlMap resource with the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#validate">validate(project, urlMap, body)</a></code></p>
+<p class="firstline">Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, urlMap)</code>
+ <pre>Deletes the specified UrlMap resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ urlMap: string, Name of the UrlMap resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, urlMap)</code>
+ <pre>Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ urlMap: string, Name of the UrlMap resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
+ "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
+ "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
+ { # Message for the expected URL mappings.
+ "path": "A String", # Path portion of the URL.
+ "host": "A String", # Host portion of the URL.
+ "description": "A String", # Description of this test case.
+ "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
+ "pathMatchers": [ # The list of named PathMatchers to use against the URL.
+ { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
+ "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
+ # - compute/v1/projects/project/global/backendServices/backendService
+ # - global/backendServices/backendService
+ "pathRules": [ # The list of path rules.
+ { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
+ "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
+ "A String",
+ ],
+ "service": "A String", # The URL of the BackendService resource if this rule is matched.
+ },
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "hostRules": [ # The list of HostRules to use against the URL.
+ { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
+ "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
+ },
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a UrlMap resource in the specified project using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
+ "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
+ "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
+ { # Message for the expected URL mappings.
+ "path": "A String", # Path portion of the URL.
+ "host": "A String", # Host portion of the URL.
+ "description": "A String", # Description of this test case.
+ "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
+ "pathMatchers": [ # The list of named PathMatchers to use against the URL.
+ { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
+ "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
+ # - compute/v1/projects/project/global/backendServices/backendService
+ # - global/backendServices/backendService
+ "pathRules": [ # The list of path rules.
+ { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
+ "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
+ "A String",
+ ],
+ "service": "A String", # The URL of the BackendService resource if this rule is matched.
+ },
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "hostRules": [ # The list of HostRules to use against the URL.
+ { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
+ "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
+ },
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="invalidateCache">invalidateCache(project, urlMap, body)</code>
+ <pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
+
+Args:
+ project: string, Project ID for this request. (required)
+ urlMap: string, Name of the UrlMap scoping this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "path": "A String",
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of UrlMap resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of UrlMap resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # A list of UrlMap resources.
+ { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
+ "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
+ "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
+ { # Message for the expected URL mappings.
+ "path": "A String", # Path portion of the URL.
+ "host": "A String", # Host portion of the URL.
+ "description": "A String", # Description of this test case.
+ "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
+ "pathMatchers": [ # The list of named PathMatchers to use against the URL.
+ { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
+ "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
+ # - compute/v1/projects/project/global/backendServices/backendService
+ # - global/backendServices/backendService
+ "pathRules": [ # The list of path rules.
+ { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
+ "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
+ "A String",
+ ],
+ "service": "A String", # The URL of the BackendService resource if this rule is matched.
+ },
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "hostRules": [ # The list of HostRules to use against the URL.
+ { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
+ "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
+ },
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#urlMapList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, urlMap, body)</code>
+ <pre>Updates the specified UrlMap resource with the data included in the request. This method supports patch semantics.
+
+Args:
+ project: string, Project ID for this request. (required)
+ urlMap: string, Name of the UrlMap resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
+ "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
+ "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
+ { # Message for the expected URL mappings.
+ "path": "A String", # Path portion of the URL.
+ "host": "A String", # Host portion of the URL.
+ "description": "A String", # Description of this test case.
+ "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
+ "pathMatchers": [ # The list of named PathMatchers to use against the URL.
+ { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
+ "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
+ # - compute/v1/projects/project/global/backendServices/backendService
+ # - global/backendServices/backendService
+ "pathRules": [ # The list of path rules.
+ { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
+ "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
+ "A String",
+ ],
+ "service": "A String", # The URL of the BackendService resource if this rule is matched.
+ },
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "hostRules": [ # The list of HostRules to use against the URL.
+ { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
+ "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
+ },
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, urlMap, body)</code>
+ <pre>Updates the specified UrlMap resource with the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ urlMap: string, Name of the UrlMap resource to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
+ "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
+ "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
+ { # Message for the expected URL mappings.
+ "path": "A String", # Path portion of the URL.
+ "host": "A String", # Host portion of the URL.
+ "description": "A String", # Description of this test case.
+ "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
+ "pathMatchers": [ # The list of named PathMatchers to use against the URL.
+ { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
+ "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
+ # - compute/v1/projects/project/global/backendServices/backendService
+ # - global/backendServices/backendService
+ "pathRules": [ # The list of path rules.
+ { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
+ "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
+ "A String",
+ ],
+ "service": "A String", # The URL of the BackendService resource if this rule is matched.
+ },
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "hostRules": [ # The list of HostRules to use against the URL.
+ { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
+ "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
+ },
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="validate">validate(project, urlMap, body)</code>
+ <pre>Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.
+
+Args:
+ project: string, Project ID for this request. (required)
+ urlMap: string, Name of the UrlMap resource to be validated as. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "resource": { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. # Content of the UrlMap to be validated.
+ "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
+ "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
+ { # Message for the expected URL mappings.
+ "path": "A String", # Path portion of the URL.
+ "host": "A String", # Host portion of the URL.
+ "description": "A String", # Description of this test case.
+ "service": "A String", # Expected BackendService resource the given URL should be mapped to.
+ },
+ ],
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
+ "pathMatchers": [ # The list of named PathMatchers to use against the URL.
+ { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
+ "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
+ # - compute/v1/projects/project/global/backendServices/backendService
+ # - global/backendServices/backendService
+ "pathRules": [ # The list of path rules.
+ { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
+ "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
+ "A String",
+ ],
+ "service": "A String", # The URL of the BackendService resource if this rule is matched.
+ },
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
+ },
+ ],
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "hostRules": [ # The list of HostRules to use against the URL.
+ { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
+ "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
+ },
+ ],
+ "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "result": { # Message representing the validation result for a UrlMap.
+ "testFailures": [
+ {
+ "path": "A String",
+ "actualService": "A String",
+ "host": "A String",
+ "expectedService": "A String",
+ },
+ ],
+ "loadErrors": [
+ "A String",
+ ],
+ "testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.
+ "loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.vpnTunnels.html b/docs/dyn/compute_beta.vpnTunnels.html
new file mode 100644
index 0000000..aca6af1
--- /dev/null
+++ b/docs/dyn/compute_beta.vpnTunnels.html
@@ -0,0 +1,473 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.vpnTunnels.html">vpnTunnels</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves an aggregated list of VPN tunnels.</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, vpnTunnel)</a></code></p>
+<p class="firstline">Deletes the specified VpnTunnel resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, region, vpnTunnel)</a></code></p>
+<p class="firstline">Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, region, body)</a></code></p>
+<p class="firstline">Creates a VpnTunnel resource in the specified project and region using the data included in the request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a list of VpnTunnel resources contained in the specified project and 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>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves an aggregated list of VPN tunnels.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": { # [Output Only] A map of scoped vpn tunnel lists.
+ "a_key": { # Name of the scope containing this set of vpn tunnels.
+ "vpnTunnels": [ # List of vpn tunnels contained in this scope.
+ {
+ "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
+ "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
+ "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "peerIp": "A String", # IP address of the peer VPN gateway.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+ "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
+ "status": "A String", # [Output Only] The status of the VPN tunnel.
+ "sharedSecretHash": "A String", # Hash of the shared secret.
+ "router": "A String", # URL of router resource to be used for dynamic routing.
+ "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "warning": { # Informational warning which replaces the list of addresses when the list is empty.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ },
+ },
+ "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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, vpnTunnel)</code>
+ <pre>Deletes the specified VpnTunnel resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ vpnTunnel: string, Name of the VpnTunnel resource to delete. (required)
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, region, vpnTunnel)</code>
+ <pre>Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ vpnTunnel: string, Name of the VpnTunnel resource to return. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
+ "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
+ "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "peerIp": "A String", # IP address of the peer VPN gateway.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+ "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
+ "status": "A String", # [Output Only] The status of the VPN tunnel.
+ "sharedSecretHash": "A String", # Hash of the shared secret.
+ "router": "A String", # URL of router resource to be used for dynamic routing.
+ "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, region, body)</code>
+ <pre>Creates a VpnTunnel resource in the specified project and region using the data included in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
+ "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
+ "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "peerIp": "A String", # IP address of the peer VPN gateway.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+ "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
+ "status": "A String", # [Output Only] The status of the VPN tunnel.
+ "sharedSecretHash": "A String", # Hash of the shared secret.
+ "router": "A String", # URL of router resource to be used for dynamic routing.
+ "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource, used to manage asynchronous API requests.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "progress": 42, # [Output Only] 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 when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ ],
+ "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "name": "A String", # [Output Only] Name of the resource.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ },
+ ],
+ },
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of VpnTunnel resources contained in the specified project and region.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of VpnTunnel resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of VpnTunnel resources.
+ {
+ "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
+ "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
+ "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "peerIp": "A String", # IP address of the peer VPN gateway.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+ "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+ "A String",
+ ],
+ "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
+ "status": "A String", # [Output Only] The status of the VPN tunnel.
+ "sharedSecretHash": "A String", # Hash of the shared secret.
+ "router": "A String", # URL of router resource to be used for dynamic routing.
+ "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ },
+ ],
+ "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name of the resource for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.operations.html b/docs/dyn/compute_beta.zoneOperations.html
similarity index 77%
copy from docs/dyn/serviceregistry_alpha.operations.html
copy to docs/dyn/compute_beta.zoneOperations.html
index eec2283..f049ccb 100644
--- a/docs/dyn/serviceregistry_alpha.operations.html
+++ b/docs/dyn/compute_beta.zoneOperations.html
@@ -72,25 +72,40 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a> . <a href="serviceregistry_alpha.operations.html">operations</a></h1>
+<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.zoneOperations.html">zoneOperations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#get">get(project, operation)</a></code></p>
-<p class="firstline">Gets information about a specific operation.</p>
+ <code><a href="#delete">delete(project, zone, operation)</a></code></p>
+<p class="firstline">Deletes the specified zone-specific Operations resource.</p>
<p class="toc_element">
- <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists all operations for a project.</p>
+ <code><a href="#get">get(project, zone, operation)</a></code></p>
+<p class="firstline">Retrieves the specified zone-specific Operations resource.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Retrieves a 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="get">get(project, operation)</code>
- <pre>Gets information about a specific operation.
+ <code class="details" id="delete">delete(project, zone, operation)</code>
+ <pre>Deletes the specified zone-specific Operations resource.
Args:
- project: string, The project ID for this request. (required)
- operation: string, The name of the operation for this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ operation: string, Name of the Operations 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 Operations resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. (required)
+ operation: string, Name of the Operations resource to return. (required)
Returns:
An object of the form:
@@ -124,7 +139,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -138,16 +153,17 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all operations for a project.
+ <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves a list of Operation resources contained within the specified zone.
Args:
- project: string, The project ID for this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
@@ -161,16 +177,16 @@
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
-Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
-The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
- { # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "operations": [ # [Output Only] Operations contained in this list response.
+ { # Contains a list of Operation resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Operation resources.
{ # An Operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] Reserved for future use.
@@ -200,7 +216,7 @@
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
@@ -214,9 +230,12 @@
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
},
],
+ "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
diff --git a/docs/dyn/compute_beta.zones.html b/docs/dyn/compute_beta.zones.html
new file mode 100644
index 0000000..7e1e359
--- /dev/null
+++ b/docs/dyn/compute_beta.zones.html
@@ -0,0 +1,184 @@
+<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_beta.html">Compute Engine API</a> . <a href="compute_beta.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. Get a list of available zones by making a list() request.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, 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. Get a list of available zones by making a list() request.
+
+Args:
+ project: string, Project ID for 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", # [Output Only] Status of the zone, either UP or DOWN.
+ "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
+ "description": "A String", # [Output Only] Textual description of the resource.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Retrieves the list of Zone resources available to the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+ pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+ filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+
+You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of zone resources.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "items": [ # [Output Only] A list of Zone resources.
+ { # A Zone resource.
+ "status": "A String", # [Output Only] Status of the zone, either UP or DOWN.
+ "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones.
+ "description": "A String", # [Output Only] Textual description of the resource.
+ "deprecated": { # Deprecation status for a public resource. # [Output Only] 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 of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and 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", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
+ },
+ "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "name": "A String", # [Output Only] Name of the resource.
+ },
+ ],
+ "kind": "compute#zoneList", # Type of resource.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html
index c6f42ee..c431128 100644
--- a/docs/dyn/compute_v1.disks.html
+++ b/docs/dyn/compute_v1.disks.html
@@ -159,7 +159,7 @@
"zone": "A String", # [Output Only] URL of the zone where the disk resides.
"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
- "status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
+ "status": "A String", # [Output Only] The status of disk creation.
"sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
# - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
# - projects/project/global/snapshots/snapshot
@@ -422,7 +422,7 @@
"zone": "A String", # [Output Only] URL of the zone where the disk resides.
"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
- "status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
+ "status": "A String", # [Output Only] The status of disk creation.
"sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
# - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
# - projects/project/global/snapshots/snapshot
@@ -498,7 +498,7 @@
"zone": "A String", # [Output Only] URL of the zone where the disk resides.
"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
- "status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
+ "status": "A String", # [Output Only] The status of disk creation.
"sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
# - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
# - projects/project/global/snapshots/snapshot
@@ -645,7 +645,7 @@
"zone": "A String", # [Output Only] URL of the zone where the disk resides.
"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
- "status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
+ "status": "A String", # [Output Only] The status of disk creation.
"sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
# - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
# - projects/project/global/snapshots/snapshot
diff --git a/docs/dyn/compute_v1.images.html b/docs/dyn/compute_v1.images.html
index adcbfbc..5a85a9e 100644
--- a/docs/dyn/compute_v1.images.html
+++ b/docs/dyn/compute_v1.images.html
@@ -238,8 +238,8 @@
{ # An Image resource.
"sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
- # - projects/project/zones/zone/disk/disk
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
# - zones/zone/disks/disk
"status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
"kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
@@ -298,8 +298,8 @@
{ # An Image resource.
"sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
- # - projects/project/zones/zone/disk/disk
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
# - zones/zone/disks/disk
"status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
"kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
@@ -356,8 +356,8 @@
{ # An Image resource.
"sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
- # - projects/project/zones/zone/disk/disk
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
# - zones/zone/disks/disk
"status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
"kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
@@ -484,8 +484,8 @@
"items": [ # [Output Only] A list of Image resources.
{ # An Image resource.
"sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
- # - projects/project/zones/zone/disk/disk
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
+ # - projects/project/zones/zone/disks/disk
# - zones/zone/disks/disk
"status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
"kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
diff --git a/docs/dyn/compute_v1.routers.html b/docs/dyn/compute_v1.routers.html
index 821acf9..155ca21 100644
--- a/docs/dyn/compute_v1.routers.html
+++ b/docs/dyn/compute_v1.routers.html
@@ -142,7 +142,7 @@
{ # Router resource.
"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
- "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel) or IP address and IP address range (e.g. ipRange).
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
{
"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
@@ -277,7 +277,7 @@
{ # Router resource.
"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
- "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel) or IP address and IP address range (e.g. ipRange).
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
{
"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
@@ -430,7 +430,7 @@
{ # Router resource.
"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
- "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel) or IP address and IP address range (e.g. ipRange).
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
{
"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
@@ -542,7 +542,7 @@
{ # Router resource.
"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
- "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel) or IP address and IP address range (e.g. ipRange).
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
{
"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
@@ -604,7 +604,7 @@
{ # Router resource.
"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
- "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel) or IP address and IP address range (e.g. ipRange).
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
{
"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
@@ -697,7 +697,7 @@
{ # Router resource.
"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
- "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel) or IP address and IP address range (e.g. ipRange).
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
{
"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
@@ -733,7 +733,7 @@
"resource": { # Router resource. # Preview of given router.
"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
- "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel) or IP address and IP address range (e.g. ipRange).
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
{
"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
@@ -777,7 +777,7 @@
{ # Router resource.
"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
- "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel) or IP address and IP address range (e.g. ipRange).
+ "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
{
"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
diff --git a/docs/dyn/computeaccounts_alpha.globalAccountsOperations.html b/docs/dyn/computeaccounts_alpha.globalAccountsOperations.html
deleted file mode 100644
index 9ada186..0000000
--- a/docs/dyn/computeaccounts_alpha.globalAccountsOperations.html
+++ /dev/null
@@ -1,237 +0,0 @@
-<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="computeaccounts_alpha.html">Compute Accounts API</a> . <a href="computeaccounts_alpha.globalAccountsOperations.html">globalAccountsOperations</a></h1>
-<h2>Instance Methods</h2>
-<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, orderBy=None, 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="delete">delete(project, operation)</code>
- <pre>Deletes the specified operation resource.
-
-Args:
- project: string, Project ID for 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, Project ID for 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", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Retrieves the list of operation resources contained within the specified project.
-
-Args:
- project: string, Project ID for this request. (required)
- orderBy: string, A parameter
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
- filter: string, Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of operation resources.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
- "items": [ # [Output Only] The operation resources.
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- },
- ],
- "kind": "computeaccounts#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Server defined URL for this resource.
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/computeaccounts_alpha.groups.html b/docs/dyn/computeaccounts_alpha.groups.html
deleted file mode 100644
index c4ab412..0000000
--- a/docs/dyn/computeaccounts_alpha.groups.html
+++ /dev/null
@@ -1,428 +0,0 @@
-<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="computeaccounts_alpha.html">Compute Accounts API</a> . <a href="computeaccounts_alpha.groups.html">groups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#addMember">addMember(project, groupName, body)</a></code></p>
-<p class="firstline">Adds users to the specified group.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(project, groupName)</a></code></p>
-<p class="firstline">Deletes the specified Group resource.</p>
-<p class="toc_element">
- <code><a href="#get">get(project, groupName)</a></code></p>
-<p class="firstline">Returns the specified Group resource.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates a Group resource in the specified project using the data included in the request.</p>
-<p class="toc_element">
- <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Retrieves the list of groups 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>
-<p class="toc_element">
- <code><a href="#removeMember">removeMember(project, groupName, body)</a></code></p>
-<p class="firstline">Removes users from the specified group.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="addMember">addMember(project, groupName, body)</code>
- <pre>Adds users to the specified group.
-
-Args:
- project: string, Project ID for this request. (required)
- groupName: string, Name of the group for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "users": [ # Fully-qualified URLs of the User resources to add.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(project, groupName)</code>
- <pre>Deletes the specified Group resource.
-
-Args:
- project: string, Project ID for this request. (required)
- groupName: string, Name of the Group resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(project, groupName)</code>
- <pre>Returns the specified Group resource.
-
-Args:
- project: string, Project ID for this request. (required)
- groupName: string, Name of the Group resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A Group resource.
- "kind": "computeaccounts#group", # [Output Only] Type of the resource. Always computeaccounts#group for groups.
- "name": "A String", # Name of the resource; provided by the client when the resource is created.
- "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
- "A String",
- ],
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "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 Group resource in the specified project using the data included in the request.
-
-Args:
- project: string, Project ID for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Group resource.
- "kind": "computeaccounts#group", # [Output Only] Type of the resource. Always computeaccounts#group for groups.
- "name": "A String", # Name of the resource; provided by the client when the resource is created.
- "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
- "A String",
- ],
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "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", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Retrieves the list of groups contained within the specified project.
-
-Args:
- project: string, Project ID for this request. (required)
- orderBy: string, A parameter
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
- filter: string, Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "items": [ # [Output Only] A list of Group resources.
- { # A Group resource.
- "kind": "computeaccounts#group", # [Output Only] Type of the resource. Always computeaccounts#group for groups.
- "name": "A String", # Name of the resource; provided by the client when the resource is created.
- "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project.
- "A String",
- ],
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- },
- ],
- "kind": "computeaccounts#groupList", # [Output Only] Type of resource. Always computeaccounts#groupList for lists of groups.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Server defined URL for this resource.
- }</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="removeMember">removeMember(project, groupName, body)</code>
- <pre>Removes users from the specified group.
-
-Args:
- project: string, Project ID for this request. (required)
- groupName: string, Name of the group for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "users": [ # Fully-qualified URLs of the User resources to remove.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/computeaccounts_alpha.linux.html b/docs/dyn/computeaccounts_alpha.linux.html
deleted file mode 100644
index 2f78ca3..0000000
--- a/docs/dyn/computeaccounts_alpha.linux.html
+++ /dev/null
@@ -1,149 +0,0 @@
-<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="computeaccounts_alpha.html">Compute Accounts API</a> . <a href="computeaccounts_alpha.linux.html">linux</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#getAuthorizedKeysView">getAuthorizedKeysView(project, zone, user, instance)</a></code></p>
-<p class="firstline">Returns a list of authorized public keys for a specific user account.</p>
-<p class="toc_element">
- <code><a href="#getLinuxAccountViews">getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None, user=None)</a></code></p>
-<p class="firstline">Retrieves a list of user accounts for an instance within a specific project.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="getAuthorizedKeysView">getAuthorizedKeysView(project, zone, user, instance)</code>
- <pre>Returns a list of authorized public keys for a specific user account.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, Name of the zone for this request. (required)
- user: string, The user account for which you want to get a list of authorized public keys. (required)
- instance: string, The fully-qualified URL of the virtual machine requesting the view. (required)
-
-Returns:
- An object of the form:
-
- {
- "resource": { # A list of authorized public keys for a user account. # [Output Only] A list of authorized public keys for a user.
- "keys": [ # [Output Only] The list of authorized public keys in SSH format.
- "A String",
- ],
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="getLinuxAccountViews">getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None, user=None)</code>
- <pre>Retrieves a list of user accounts for an instance within a specific project.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, Name of the zone for this request. (required)
- instance: string, The fully-qualified URL of the virtual machine requesting the views. (required)
- orderBy: string, A parameter
- filter: string, Filter expression for filtering listed resources.
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
- user: string, If provided, the user requesting the views. If left blank, the system is requesting the views, instead of a particular user.
-
-Returns:
- An object of the form:
-
- {
- "resource": { # A list of all Linux accounts for this project. This API is only used by Compute Engine virtual machines to get information about user accounts for a project or instance. Linux resources are read-only views into users and groups managed by the Compute Engine Accounts API. # [Output Only] A list of authorized user accounts and groups.
- "kind": "computeaccounts#linuxAccountViews", # [Output Only] Type of the resource. Always computeaccounts#linuxAccountViews for Linux resources.
- "userViews": [ # [Output Only] A list of all users within a project.
- { # A detailed view of a Linux user account.
- "username": "A String", # [Output Only] The username of the account.
- "shell": "A String", # [Output Only] The path to the login shell for this account.
- "uid": 42, # [Output Only] User ID.
- "gid": 42, # [Output Only] User's default group ID.
- "gecos": "A String", # [Output Only] The GECOS (user information) entry for this account.
- "homeDirectory": "A String", # [Output Only] The path to the home directory for this account.
- },
- ],
- "groupViews": [ # [Output Only] A list of all groups within a project.
- { # A detailed view of a Linux group.
- "groupName": "A String", # [Output Only] Group name.
- "gid": 42, # [Output Only] The Group ID.
- "members": [ # [Output Only] List of user accounts that belong to the group.
- "A String",
- ],
- },
- ],
- },
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/computeaccounts_alpha.users.html b/docs/dyn/computeaccounts_alpha.users.html
deleted file mode 100644
index 9592be3..0000000
--- a/docs/dyn/computeaccounts_alpha.users.html
+++ /dev/null
@@ -1,452 +0,0 @@
-<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="computeaccounts_alpha.html">Compute Accounts API</a> . <a href="computeaccounts_alpha.users.html">users</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#addPublicKey">addPublicKey(project, user, body)</a></code></p>
-<p class="firstline">Adds a public key to the specified User resource with the data included in the request.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(project, user)</a></code></p>
-<p class="firstline">Deletes the specified User resource.</p>
-<p class="toc_element">
- <code><a href="#get">get(project, user)</a></code></p>
-<p class="firstline">Returns the specified User resource.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates a User resource in the specified project using the data included in the request.</p>
-<p class="toc_element">
- <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Retrieves a list of users 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>
-<p class="toc_element">
- <code><a href="#removePublicKey">removePublicKey(project, user, fingerprint)</a></code></p>
-<p class="firstline">Removes the specified public key from the user.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="addPublicKey">addPublicKey(project, user, body)</code>
- <pre>Adds a public key to the specified User resource with the data included in the request.
-
-Args:
- project: string, Project ID for this request. (required)
- user: string, Name of the user for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A public key for authenticating to guests.
- "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
- "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
-}
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(project, user)</code>
- <pre>Deletes the specified User resource.
-
-Args:
- project: string, Project ID for this request. (required)
- user: string, Name of the user resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(project, user)</code>
- <pre>Returns the specified User resource.
-
-Args:
- project: string, Project ID for this request. (required)
- user: string, Name of the user resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A User resource.
- "kind": "computeaccounts#user", # [Output Only] Type of the resource. Always computeaccounts#user for users.
- "name": "A String", # Name of the resource; provided by the client when the resource is created.
- "publicKeys": [ # [Output Only] Public keys that this user may use to login.
- { # A public key for authenticating to guests.
- "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
- "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
- },
- ],
- "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
- "A String",
- ],
- "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "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 User resource in the specified project using the data included in the request.
-
-Args:
- project: string, Project ID for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A User resource.
- "kind": "computeaccounts#user", # [Output Only] Type of the resource. Always computeaccounts#user for users.
- "name": "A String", # Name of the resource; provided by the client when the resource is created.
- "publicKeys": [ # [Output Only] Public keys that this user may use to login.
- { # A public key for authenticating to guests.
- "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
- "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
- },
- ],
- "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
- "A String",
- ],
- "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "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", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Retrieves a list of users contained within the specified project.
-
-Args:
- project: string, Project ID for this request. (required)
- orderBy: string, A parameter
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
- filter: string, Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "items": [ # [Output Only] A list of User resources.
- { # A User resource.
- "kind": "computeaccounts#user", # [Output Only] Type of the resource. Always computeaccounts#user for users.
- "name": "A String", # Name of the resource; provided by the client when the resource is created.
- "publicKeys": [ # [Output Only] Public keys that this user may use to login.
- { # A public key for authenticating to guests.
- "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
- "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
- },
- ],
- "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
- "A String",
- ],
- "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- },
- ],
- "kind": "computeaccounts#userList", # [Output Only] Type of resource. Always computeaccounts#userList for lists of users.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Server defined URL for this resource.
- }</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="removePublicKey">removePublicKey(project, user, fingerprint)</code>
- <pre>Removes the specified public key from the user.
-
-Args:
- project: string, Project ID for this request. (required)
- user: string, Name of the user for this request. (required)
- fingerprint: string, The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/container_v1beta1.html b/docs/dyn/container_v1beta1.html
deleted file mode 100644
index 065e255..0000000
--- a/docs/dyn/container_v1beta1.html
+++ /dev/null
@@ -1,103 +0,0 @@
-<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="container_v1beta1.html">Google Container Engine API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="container_v1beta1.projects.html">projects()</a></code>
-</p>
-<p class="firstline">Returns the projects Resource.</p>
-
-<p class="toc_element">
- <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
-<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
- <pre>Create a BatchHttpRequest object based on the discovery document.
-
- Args:
- callback: callable, A callback to be called for each response, of the
- form callback(id, response, exception). The first parameter is the
- request id, and the second is the deserialized response object. The
- third is an apiclient.errors.HttpError exception object if an HTTP
- error occurred while processing the request, or None if no error
- occurred.
-
- Returns:
- A BatchHttpRequest object based on the discovery document.
- </pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/container_v1beta1.projects.clusters.html b/docs/dyn/container_v1beta1.projects.clusters.html
deleted file mode 100644
index d116563..0000000
--- a/docs/dyn/container_v1beta1.projects.clusters.html
+++ /dev/null
@@ -1,149 +0,0 @@
-<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="container_v1beta1.html">Google Container Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.clusters.html">clusters</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(projectId)</a></code></p>
-<p class="firstline">Lists all clusters owned by a project across all zones.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(projectId)</code>
- <pre>Lists all clusters owned by a project across all zones.
-
-Args:
- projectId: string, The Google Developers Console project ID or project number. (required)
-
-Returns:
- An object of the form:
-
- {
- "clusters": [ # A list of clusters in the project, across all zones.
- {
- "status": "A String", # [Output only] The current status of this cluster.
- "containerIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8 or 172.16.0.0/12.
- "description": "A String", # An optional description of this cluster.
- "name": "A String", # The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions:
- # - Lowercase letters, numbers, and hyphens only.
- # - Must start with a letter.
- # - Must end with a number or a letter.
- "numNodes": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances plus one (to include the master). You must also have available firewall and routes quota.
- "nodeRoutingPrefixSize": 42, # [Output only] The size of the address space on each node for hosting containers.
- "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
- "A String",
- ],
- "masterAuth": { # The authentication information for accessing the master. Authentication is either done using HTTP basic authentication or using a bearer token. # The authentication information for accessing the master.
- "bearerToken": "A String", # The token used to authenticate API requests to the master. The token is to be included in an HTTP Authorization Header in all requests to the master endpoint. The format of the header is: "Authorization: Bearer ".
- "clientKey": "A String", # [Output only] Base64 encoded private key used by clients to authenticate to the cluster endpoint.
- "clientCertificate": "A String", # [Output only] Base64 encoded public certificate used by clients to authenticate to the cluster endpoint.
- "user": "A String", # The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
- "password": "A String", # The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint. Because the master endpoint is open to the internet, you should create a strong password.
- "clusterCaCertificate": "A String", # [Output only] Base64 encoded public certificate that is the root of trust for the cluster.
- },
- "clusterApiVersion": "A String", # The API version of the Kubernetes master and kubelets running in this cluster. Leave blank to pick up the latest stable release, or specify a version of the form "x.y.z". The Google Container Engine release notes lists the currently supported versions. If an incorrect version is specified, the server returns an error listing the currently supported versions.
- "network": "A String", # The name of the Google Compute Engine network to which the cluster is connected.
- "zone": "A String", # [Output only] The name of the Google Compute Engine zone in which the cluster resides.
- "endpoint": "A String", # [Output only] The IP address of this cluster's Kubernetes master. The endpoint can be accessed from the internet at https://username:password@endpoint/.
- #
- # See the masterAuth property of this resource for username and password information.
- "nodeConfig": { # The machine type and image to use for all nodes in this cluster. See the descriptions of the child properties of nodeConfig.
- "serviceAccounts": [ # The optional list of ServiceAccounts, each with their specified scopes, to be made available on all of the node VMs. In addition to the service accounts and scopes specified, the "default" account will always be created with the following scopes to ensure the correct functioning of the cluster:
- # - https://www.googleapis.com/auth/compute,
- # - https://www.googleapis.com/auth/devstorage.read_only
- { # A Compute Engine service account.
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "email": "A String", # Email address of the service account.
- },
- ],
- "machineType": "A String", # The name of a Google Compute Engine machine type (e.g. n1-standard-1).
- #
- # If unspecified, the default machine type is n1-standard-1.
- "sourceImage": "A String", # The fully-specified name of a Google Compute Engine image. For example: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/backports-debian-7-wheezy-vYYYYMMDD (where YYYMMDD is the version date).
- #
- # If specifying an image, you are responsible for ensuring its compatibility with the Debian 7 backports image. We recommend leaving this field blank to accept the default backports-debian-7-wheezy value.
- },
- "statusMessage": "A String", # [Output only] Additional information about the current status of this cluster, if available.
- "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.
- "creationTimestamp": "A String", # [Output only] The time the cluster was created, in RFC3339 text format.
- "enableCloudLogging": True or False, # Whether logs from the cluster should be made available via the Google Cloud Logging service. This includes both logs from your applications running in the cluster as well as logs from the Kubernetes components themselves.
- "selfLink": "A String", # [Output only] Server-defined URL for the resource.
- "enableCloudMonitoring": True or False, # Whether metrics from the cluster should be made available via the Google Cloud Monitoring service.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/container_v1beta1.projects.html b/docs/dyn/container_v1beta1.projects.html
deleted file mode 100644
index b02370a..0000000
--- a/docs/dyn/container_v1beta1.projects.html
+++ /dev/null
@@ -1,92 +0,0 @@
-<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="container_v1beta1.html">Google Container Engine API</a> . <a href="container_v1beta1.projects.html">projects</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="container_v1beta1.projects.clusters.html">clusters()</a></code>
-</p>
-<p class="firstline">Returns the clusters Resource.</p>
-
-<p class="toc_element">
- <code><a href="container_v1beta1.projects.operations.html">operations()</a></code>
-</p>
-<p class="firstline">Returns the operations Resource.</p>
-
-<p class="toc_element">
- <code><a href="container_v1beta1.projects.zones.html">zones()</a></code>
-</p>
-<p class="firstline">Returns the zones Resource.</p>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/container_v1beta1.projects.operations.html b/docs/dyn/container_v1beta1.projects.operations.html
deleted file mode 100644
index 30e9144..0000000
--- a/docs/dyn/container_v1beta1.projects.operations.html
+++ /dev/null
@@ -1,107 +0,0 @@
-<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="container_v1beta1.html">Google Container Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.operations.html">operations</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(projectId)</a></code></p>
-<p class="firstline">Lists all operations in a project, across all zones.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(projectId)</code>
- <pre>Lists all operations in a project, across all zones.
-
-Args:
- projectId: string, The Google Developers Console project ID or project number. (required)
-
-Returns:
- An object of the form:
-
- {
- "operations": [ # A list of operations in the project, across all zones.
- { # Defines the operation resource. All fields are output only.
- "status": "A String", # The current status of the operation.
- "name": "A String", # The server-assigned ID for the operation.
- "zone": "A String", # The name of the Google Compute Engine zone in which the operation is taking place.
- "errorMessage": "A String", # If an error has occurred, a textual description of the error.
- "targetLink": "A String", # Server-defined URL for the target of the operation.
- "operationType": "A String", # The operation type.
- "selfLink": "A String", # Server-defined URL for the resource.
- "target": "A String", # [Optional] The URL of the cluster resource that this operation is associated with.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html
deleted file mode 100644
index 2a696bb..0000000
--- a/docs/dyn/container_v1beta1.projects.zones.clusters.html
+++ /dev/null
@@ -1,338 +0,0 @@
-<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="container_v1beta1.html">Google Container Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.zones.html">zones</a> . <a href="container_v1beta1.projects.zones.clusters.html">clusters</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#create">create(projectId, zoneId, body)</a></code></p>
-<p class="firstline">Creates a cluster, consisting of the specified number and type of Google Compute Engine instances, plus a Kubernetes master instance.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(projectId, zoneId, clusterId)</a></code></p>
-<p class="firstline">Deletes the cluster, including the Kubernetes master and all worker nodes.</p>
-<p class="toc_element">
- <code><a href="#get">get(projectId, zoneId, clusterId)</a></code></p>
-<p class="firstline">Gets a specific cluster.</p>
-<p class="toc_element">
- <code><a href="#list">list(projectId, zoneId)</a></code></p>
-<p class="firstline">Lists all clusters owned by a project in the specified zone.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(projectId, zoneId, body)</code>
- <pre>Creates a cluster, consisting of the specified number and type of Google Compute Engine instances, plus a Kubernetes master instance.
-
-The cluster is created in the project's default network.
-
-A firewall is added that allows traffic into port 443 on the master, which enables HTTPS. A firewall and a route is added for each node to allow the containers on that node to communicate with all other instances in the cluster.
-
-Finally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.
-
-Args:
- projectId: string, The Google Developers Console project ID or project number. (required)
- zoneId: string, The name of the Google Compute Engine zone in which the cluster resides. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "cluster": { # A cluster resource.
- "status": "A String", # [Output only] The current status of this cluster.
- "containerIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8 or 172.16.0.0/12.
- "description": "A String", # An optional description of this cluster.
- "name": "A String", # The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions:
- # - Lowercase letters, numbers, and hyphens only.
- # - Must start with a letter.
- # - Must end with a number or a letter.
- "numNodes": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances plus one (to include the master). You must also have available firewall and routes quota.
- "nodeRoutingPrefixSize": 42, # [Output only] The size of the address space on each node for hosting containers.
- "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
- "A String",
- ],
- "masterAuth": { # The authentication information for accessing the master. Authentication is either done using HTTP basic authentication or using a bearer token. # The authentication information for accessing the master.
- "bearerToken": "A String", # The token used to authenticate API requests to the master. The token is to be included in an HTTP Authorization Header in all requests to the master endpoint. The format of the header is: "Authorization: Bearer ".
- "clientKey": "A String", # [Output only] Base64 encoded private key used by clients to authenticate to the cluster endpoint.
- "clientCertificate": "A String", # [Output only] Base64 encoded public certificate used by clients to authenticate to the cluster endpoint.
- "user": "A String", # The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
- "password": "A String", # The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint. Because the master endpoint is open to the internet, you should create a strong password.
- "clusterCaCertificate": "A String", # [Output only] Base64 encoded public certificate that is the root of trust for the cluster.
- },
- "clusterApiVersion": "A String", # The API version of the Kubernetes master and kubelets running in this cluster. Leave blank to pick up the latest stable release, or specify a version of the form "x.y.z". The Google Container Engine release notes lists the currently supported versions. If an incorrect version is specified, the server returns an error listing the currently supported versions.
- "network": "A String", # The name of the Google Compute Engine network to which the cluster is connected.
- "zone": "A String", # [Output only] The name of the Google Compute Engine zone in which the cluster resides.
- "endpoint": "A String", # [Output only] The IP address of this cluster's Kubernetes master. The endpoint can be accessed from the internet at https://username:password@endpoint/.
- #
- # See the masterAuth property of this resource for username and password information.
- "nodeConfig": { # The machine type and image to use for all nodes in this cluster. See the descriptions of the child properties of nodeConfig.
- "serviceAccounts": [ # The optional list of ServiceAccounts, each with their specified scopes, to be made available on all of the node VMs. In addition to the service accounts and scopes specified, the "default" account will always be created with the following scopes to ensure the correct functioning of the cluster:
- # - https://www.googleapis.com/auth/compute,
- # - https://www.googleapis.com/auth/devstorage.read_only
- { # A Compute Engine service account.
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "email": "A String", # Email address of the service account.
- },
- ],
- "machineType": "A String", # The name of a Google Compute Engine machine type (e.g. n1-standard-1).
- #
- # If unspecified, the default machine type is n1-standard-1.
- "sourceImage": "A String", # The fully-specified name of a Google Compute Engine image. For example: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/backports-debian-7-wheezy-vYYYYMMDD (where YYYMMDD is the version date).
- #
- # If specifying an image, you are responsible for ensuring its compatibility with the Debian 7 backports image. We recommend leaving this field blank to accept the default backports-debian-7-wheezy value.
- },
- "statusMessage": "A String", # [Output only] Additional information about the current status of this cluster, if available.
- "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.
- "creationTimestamp": "A String", # [Output only] The time the cluster was created, in RFC3339 text format.
- "enableCloudLogging": True or False, # Whether logs from the cluster should be made available via the Google Cloud Logging service. This includes both logs from your applications running in the cluster as well as logs from the Kubernetes components themselves.
- "selfLink": "A String", # [Output only] Server-defined URL for the resource.
- "enableCloudMonitoring": True or False, # Whether metrics from the cluster should be made available via the Google Cloud Monitoring service.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Defines the operation resource. All fields are output only.
- "status": "A String", # The current status of the operation.
- "name": "A String", # The server-assigned ID for the operation.
- "zone": "A String", # The name of the Google Compute Engine zone in which the operation is taking place.
- "errorMessage": "A String", # If an error has occurred, a textual description of the error.
- "targetLink": "A String", # Server-defined URL for the target of the operation.
- "operationType": "A String", # The operation type.
- "selfLink": "A String", # Server-defined URL for the resource.
- "target": "A String", # [Optional] The URL of the cluster resource that this operation is associated with.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(projectId, zoneId, clusterId)</code>
- <pre>Deletes the cluster, including the Kubernetes master and all worker nodes.
-
-Firewalls and routes that were configured at cluster creation are also deleted.
-
-Args:
- projectId: string, The Google Developers Console project ID or project number. (required)
- zoneId: string, The name of the Google Compute Engine zone in which the cluster resides. (required)
- clusterId: string, The name of the cluster to delete. (required)
-
-Returns:
- An object of the form:
-
- { # Defines the operation resource. All fields are output only.
- "status": "A String", # The current status of the operation.
- "name": "A String", # The server-assigned ID for the operation.
- "zone": "A String", # The name of the Google Compute Engine zone in which the operation is taking place.
- "errorMessage": "A String", # If an error has occurred, a textual description of the error.
- "targetLink": "A String", # Server-defined URL for the target of the operation.
- "operationType": "A String", # The operation type.
- "selfLink": "A String", # Server-defined URL for the resource.
- "target": "A String", # [Optional] The URL of the cluster resource that this operation is associated with.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(projectId, zoneId, clusterId)</code>
- <pre>Gets a specific cluster.
-
-Args:
- projectId: string, The Google Developers Console project ID or project number. (required)
- zoneId: string, The name of the Google Compute Engine zone in which the cluster resides. (required)
- clusterId: string, The name of the cluster to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # [Output only] The current status of this cluster.
- "containerIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8 or 172.16.0.0/12.
- "description": "A String", # An optional description of this cluster.
- "name": "A String", # The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions:
- # - Lowercase letters, numbers, and hyphens only.
- # - Must start with a letter.
- # - Must end with a number or a letter.
- "numNodes": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances plus one (to include the master). You must also have available firewall and routes quota.
- "nodeRoutingPrefixSize": 42, # [Output only] The size of the address space on each node for hosting containers.
- "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
- "A String",
- ],
- "masterAuth": { # The authentication information for accessing the master. Authentication is either done using HTTP basic authentication or using a bearer token. # The authentication information for accessing the master.
- "bearerToken": "A String", # The token used to authenticate API requests to the master. The token is to be included in an HTTP Authorization Header in all requests to the master endpoint. The format of the header is: "Authorization: Bearer ".
- "clientKey": "A String", # [Output only] Base64 encoded private key used by clients to authenticate to the cluster endpoint.
- "clientCertificate": "A String", # [Output only] Base64 encoded public certificate used by clients to authenticate to the cluster endpoint.
- "user": "A String", # The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
- "password": "A String", # The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint. Because the master endpoint is open to the internet, you should create a strong password.
- "clusterCaCertificate": "A String", # [Output only] Base64 encoded public certificate that is the root of trust for the cluster.
- },
- "clusterApiVersion": "A String", # The API version of the Kubernetes master and kubelets running in this cluster. Leave blank to pick up the latest stable release, or specify a version of the form "x.y.z". The Google Container Engine release notes lists the currently supported versions. If an incorrect version is specified, the server returns an error listing the currently supported versions.
- "network": "A String", # The name of the Google Compute Engine network to which the cluster is connected.
- "zone": "A String", # [Output only] The name of the Google Compute Engine zone in which the cluster resides.
- "endpoint": "A String", # [Output only] The IP address of this cluster's Kubernetes master. The endpoint can be accessed from the internet at https://username:password@endpoint/.
- #
- # See the masterAuth property of this resource for username and password information.
- "nodeConfig": { # The machine type and image to use for all nodes in this cluster. See the descriptions of the child properties of nodeConfig.
- "serviceAccounts": [ # The optional list of ServiceAccounts, each with their specified scopes, to be made available on all of the node VMs. In addition to the service accounts and scopes specified, the "default" account will always be created with the following scopes to ensure the correct functioning of the cluster:
- # - https://www.googleapis.com/auth/compute,
- # - https://www.googleapis.com/auth/devstorage.read_only
- { # A Compute Engine service account.
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "email": "A String", # Email address of the service account.
- },
- ],
- "machineType": "A String", # The name of a Google Compute Engine machine type (e.g. n1-standard-1).
- #
- # If unspecified, the default machine type is n1-standard-1.
- "sourceImage": "A String", # The fully-specified name of a Google Compute Engine image. For example: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/backports-debian-7-wheezy-vYYYYMMDD (where YYYMMDD is the version date).
- #
- # If specifying an image, you are responsible for ensuring its compatibility with the Debian 7 backports image. We recommend leaving this field blank to accept the default backports-debian-7-wheezy value.
- },
- "statusMessage": "A String", # [Output only] Additional information about the current status of this cluster, if available.
- "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.
- "creationTimestamp": "A String", # [Output only] The time the cluster was created, in RFC3339 text format.
- "enableCloudLogging": True or False, # Whether logs from the cluster should be made available via the Google Cloud Logging service. This includes both logs from your applications running in the cluster as well as logs from the Kubernetes components themselves.
- "selfLink": "A String", # [Output only] Server-defined URL for the resource.
- "enableCloudMonitoring": True or False, # Whether metrics from the cluster should be made available via the Google Cloud Monitoring service.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(projectId, zoneId)</code>
- <pre>Lists all clusters owned by a project in the specified zone.
-
-Args:
- projectId: string, The Google Developers Console project ID or project number. (required)
- zoneId: string, The name of the Google Compute Engine zone in which the cluster resides. (required)
-
-Returns:
- An object of the form:
-
- {
- "clusters": [ # A list of clusters in the project in the specified zone.
- {
- "status": "A String", # [Output only] The current status of this cluster.
- "containerIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8 or 172.16.0.0/12.
- "description": "A String", # An optional description of this cluster.
- "name": "A String", # The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions:
- # - Lowercase letters, numbers, and hyphens only.
- # - Must start with a letter.
- # - Must end with a number or a letter.
- "numNodes": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances plus one (to include the master). You must also have available firewall and routes quota.
- "nodeRoutingPrefixSize": 42, # [Output only] The size of the address space on each node for hosting containers.
- "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
- "A String",
- ],
- "masterAuth": { # The authentication information for accessing the master. Authentication is either done using HTTP basic authentication or using a bearer token. # The authentication information for accessing the master.
- "bearerToken": "A String", # The token used to authenticate API requests to the master. The token is to be included in an HTTP Authorization Header in all requests to the master endpoint. The format of the header is: "Authorization: Bearer ".
- "clientKey": "A String", # [Output only] Base64 encoded private key used by clients to authenticate to the cluster endpoint.
- "clientCertificate": "A String", # [Output only] Base64 encoded public certificate used by clients to authenticate to the cluster endpoint.
- "user": "A String", # The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
- "password": "A String", # The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint. Because the master endpoint is open to the internet, you should create a strong password.
- "clusterCaCertificate": "A String", # [Output only] Base64 encoded public certificate that is the root of trust for the cluster.
- },
- "clusterApiVersion": "A String", # The API version of the Kubernetes master and kubelets running in this cluster. Leave blank to pick up the latest stable release, or specify a version of the form "x.y.z". The Google Container Engine release notes lists the currently supported versions. If an incorrect version is specified, the server returns an error listing the currently supported versions.
- "network": "A String", # The name of the Google Compute Engine network to which the cluster is connected.
- "zone": "A String", # [Output only] The name of the Google Compute Engine zone in which the cluster resides.
- "endpoint": "A String", # [Output only] The IP address of this cluster's Kubernetes master. The endpoint can be accessed from the internet at https://username:password@endpoint/.
- #
- # See the masterAuth property of this resource for username and password information.
- "nodeConfig": { # The machine type and image to use for all nodes in this cluster. See the descriptions of the child properties of nodeConfig.
- "serviceAccounts": [ # The optional list of ServiceAccounts, each with their specified scopes, to be made available on all of the node VMs. In addition to the service accounts and scopes specified, the "default" account will always be created with the following scopes to ensure the correct functioning of the cluster:
- # - https://www.googleapis.com/auth/compute,
- # - https://www.googleapis.com/auth/devstorage.read_only
- { # A Compute Engine service account.
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "email": "A String", # Email address of the service account.
- },
- ],
- "machineType": "A String", # The name of a Google Compute Engine machine type (e.g. n1-standard-1).
- #
- # If unspecified, the default machine type is n1-standard-1.
- "sourceImage": "A String", # The fully-specified name of a Google Compute Engine image. For example: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/backports-debian-7-wheezy-vYYYYMMDD (where YYYMMDD is the version date).
- #
- # If specifying an image, you are responsible for ensuring its compatibility with the Debian 7 backports image. We recommend leaving this field blank to accept the default backports-debian-7-wheezy value.
- },
- "statusMessage": "A String", # [Output only] Additional information about the current status of this cluster, if available.
- "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.
- "creationTimestamp": "A String", # [Output only] The time the cluster was created, in RFC3339 text format.
- "enableCloudLogging": True or False, # Whether logs from the cluster should be made available via the Google Cloud Logging service. This includes both logs from your applications running in the cluster as well as logs from the Kubernetes components themselves.
- "selfLink": "A String", # [Output only] Server-defined URL for the resource.
- "enableCloudMonitoring": True or False, # Whether metrics from the cluster should be made available via the Google Cloud Monitoring service.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/container_v1beta1.projects.zones.operations.html b/docs/dyn/container_v1beta1.projects.zones.operations.html
deleted file mode 100644
index 1c380c1..0000000
--- a/docs/dyn/container_v1beta1.projects.zones.operations.html
+++ /dev/null
@@ -1,135 +0,0 @@
-<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="container_v1beta1.html">Google Container Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.zones.html">zones</a> . <a href="container_v1beta1.projects.zones.operations.html">operations</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(projectId, zoneId, operationId)</a></code></p>
-<p class="firstline">Gets the specified operation.</p>
-<p class="toc_element">
- <code><a href="#list">list(projectId, zoneId)</a></code></p>
-<p class="firstline">Lists all operations in a project in a specific zone.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(projectId, zoneId, operationId)</code>
- <pre>Gets the specified operation.
-
-Args:
- projectId: string, The Google Developers Console project ID or project number. (required)
- zoneId: string, The name of the Google Compute Engine zone in which the operation resides. This is always the same zone as the cluster with which the operation is associated. (required)
- operationId: string, The server-assigned name of the operation. (required)
-
-Returns:
- An object of the form:
-
- { # Defines the operation resource. All fields are output only.
- "status": "A String", # The current status of the operation.
- "name": "A String", # The server-assigned ID for the operation.
- "zone": "A String", # The name of the Google Compute Engine zone in which the operation is taking place.
- "errorMessage": "A String", # If an error has occurred, a textual description of the error.
- "targetLink": "A String", # Server-defined URL for the target of the operation.
- "operationType": "A String", # The operation type.
- "selfLink": "A String", # Server-defined URL for the resource.
- "target": "A String", # [Optional] The URL of the cluster resource that this operation is associated with.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(projectId, zoneId)</code>
- <pre>Lists all operations in a project in a specific zone.
-
-Args:
- projectId: string, The Google Developers Console project ID or project number. (required)
- zoneId: string, The name of the Google Compute Engine zone to return operations for. (required)
-
-Returns:
- An object of the form:
-
- {
- "operations": [ # A list of operations in the project in the specified zone.
- { # Defines the operation resource. All fields are output only.
- "status": "A String", # The current status of the operation.
- "name": "A String", # The server-assigned ID for the operation.
- "zone": "A String", # The name of the Google Compute Engine zone in which the operation is taking place.
- "errorMessage": "A String", # If an error has occurred, a textual description of the error.
- "targetLink": "A String", # Server-defined URL for the target of the operation.
- "operationType": "A String", # The operation type.
- "selfLink": "A String", # Server-defined URL for the resource.
- "target": "A String", # [Optional] The URL of the cluster resource that this operation is associated with.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v1beta3.html b/docs/dyn/content_v2sandbox.html
similarity index 90%
rename from docs/dyn/logging_v1beta3.html
rename to docs/dyn/content_v2sandbox.html
index db3cf63..60c3f8c 100644
--- a/docs/dyn/logging_v1beta3.html
+++ b/docs/dyn/content_v2sandbox.html
@@ -72,12 +72,12 @@
</style>
-<h1><a href="logging_v1beta3.html">Google Cloud Logging API</a></h1>
+<h1><a href="content_v2sandbox.html">Content API for Shopping</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="logging_v1beta3.projects.html">projects()</a></code>
+ <code><a href="content_v2sandbox.orders.html">orders()</a></code>
</p>
-<p class="firstline">Returns the projects Resource.</p>
+<p class="firstline">Returns the orders Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/content_v2sandbox.orders.html b/docs/dyn/content_v2sandbox.orders.html
new file mode 100644
index 0000000..dc30f33
--- /dev/null
+++ b/docs/dyn/content_v2sandbox.orders.html
@@ -0,0 +1,1622 @@
+<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="content_v2sandbox.html">Content API for Shopping</a> . <a href="content_v2sandbox.orders.html">orders</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#acknowledge">acknowledge(merchantId, orderId, body)</a></code></p>
+<p class="firstline">Marks an order as acknowledged.</p>
+<p class="toc_element">
+ <code><a href="#advancetestorder">advancetestorder(merchantId, orderId)</a></code></p>
+<p class="firstline">Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".</p>
+<p class="toc_element">
+ <code><a href="#cancel">cancel(merchantId, orderId, body)</a></code></p>
+<p class="firstline">Cancels all line items in an order.</p>
+<p class="toc_element">
+ <code><a href="#cancellineitem">cancellineitem(merchantId, orderId, body)</a></code></p>
+<p class="firstline">Cancels a line item.</p>
+<p class="toc_element">
+ <code><a href="#createtestorder">createtestorder(merchantId, body)</a></code></p>
+<p class="firstline">Sandbox only. Creates a test order.</p>
+<p class="toc_element">
+ <code><a href="#custombatch">custombatch(body)</a></code></p>
+<p class="firstline">Retrieves or modifies multiple orders in a single request.</p>
+<p class="toc_element">
+ <code><a href="#get">get(merchantId, orderId)</a></code></p>
+<p class="firstline">Retrieves an order from your Merchant Center account.</p>
+<p class="toc_element">
+ <code><a href="#getbymerchantorderid">getbymerchantorderid(merchantId, merchantOrderId)</a></code></p>
+<p class="firstline">Retrieves an order using merchant order id.</p>
+<p class="toc_element">
+ <code><a href="#gettestordertemplate">gettestordertemplate(merchantId, templateName)</a></code></p>
+<p class="firstline">Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.</p>
+<p class="toc_element">
+ <code><a href="#list">list(merchantId, orderBy=None, pageToken=None, placedDateEnd=None, acknowledged=None, maxResults=None, placedDateStart=None, statuses=None)</a></code></p>
+<p class="firstline">Lists the orders in your Merchant Center 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>
+<p class="toc_element">
+ <code><a href="#refund">refund(merchantId, orderId, body)</a></code></p>
+<p class="firstline">Refund a portion of the order, up to the full amount paid.</p>
+<p class="toc_element">
+ <code><a href="#returnlineitem">returnlineitem(merchantId, orderId, body)</a></code></p>
+<p class="firstline">Returns a line item.</p>
+<p class="toc_element">
+ <code><a href="#shiplineitems">shiplineitems(merchantId, orderId, body)</a></code></p>
+<p class="firstline">Marks line item(s) as shipped.</p>
+<p class="toc_element">
+ <code><a href="#updatemerchantorderid">updatemerchantorderid(merchantId, orderId, body)</a></code></p>
+<p class="firstline">Updates the merchant order ID for a given order.</p>
+<p class="toc_element">
+ <code><a href="#updateshipment">updateshipment(merchantId, orderId, body)</a></code></p>
+<p class="firstline">Updates a shipment's status, carrier, and/or tracking ID.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="acknowledge">acknowledge(merchantId, orderId, body)</code>
+ <pre>Marks an order as acknowledged.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ orderId: string, The ID of the order. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#ordersAcknowledgeResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse".
+ "executionStatus": "A String", # The status of the execution.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="advancetestorder">advancetestorder(merchantId, orderId)</code>
+ <pre>Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ orderId: string, The ID of the test order to modify. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#ordersAdvanceTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="cancel">cancel(merchantId, orderId, body)</code>
+ <pre>Cancels all line items in an order.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ orderId: string, The ID of the order to cancel. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "reason": "A String", # The reason for the cancellation.
+ "reasonText": "A String", # The explanation of the reason.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#ordersCancelResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".
+ "executionStatus": "A String", # The status of the execution.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="cancellineitem">cancellineitem(merchantId, orderId, body)</code>
+ <pre>Cancels a line item.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ orderId: string, The ID of the order. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "reason": "A String", # The reason for the cancellation.
+ "amount": { # Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "reasonText": "A String", # The explanation of the reason.
+ "lineItemId": "A String", # The ID of the line item to cancel.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ "quantity": 42, # The quantity to cancel.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#ordersCancelLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse".
+ "executionStatus": "A String", # The status of the execution.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="createtestorder">createtestorder(merchantId, body)</code>
+ <pre>Sandbox only. Creates a test order.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "testOrder": { # The test order to create.
+ "customer": { # The details of the customer who placed the order.
+ "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow. Optional.
+ "fullName": "A String", # Full name of the customer.
+ "email": "A String", # Email address of the customer.
+ },
+ "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are here.
+ {
+ "benefits": [
+ {
+ "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
+ "A String",
+ ],
+ "discount": { # The discount in the order price when the promotion is applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
+ "taxImpact": { # The impact on tax when the promotion is applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
+ },
+ ],
+ "longTitle": "A String", # The full title of the promotion.
+ "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
+ "redemptionChannel": "A String", # Indicates that the promotion is valid online.
+ "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
+ "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
+ # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
+ "id": "A String", # The unique ID of the promotion.
+ },
+ ],
+ "kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "content#testOrder".
+ "shippingCostTax": { # The tax for the total shipping cost.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "predefinedDeliveryAddress": "A String", # Identifier of one of the predefined delivery addresses for the delivery.
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shippingOption": "A String", # The requested shipping option.
+ "lineItems": [ # Line items that are ordered. At least one line item must be provided.
+ {
+ "returnInfo": { # Details of the return policy for the line item.
+ "policyUrl": "A String", # URL of the item return policy.
+ "isReturnable": True or False, # Whether the item is returnable.
+ "daysToReturn": 42, # How many days later the item can be returned.
+ },
+ "product": { # Product data from the time of the order placement.
+ "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+ "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+ "title": "A String", # The title of the product.
+ "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
+ "variantAttributes": [ # Variant attributes for the item. Optional.
+ {
+ "dimension": "A String", # The dimension of the variant.
+ "value": "A String", # The value for the dimension.
+ },
+ ],
+ "brand": "A String", # Brand of the item.
+ "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
+ "offerId": "A String", # An identifier of the item.
+ "imageLink": "A String", # URL of an image of the item.
+ "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
+ "channel": "A String", # The item's channel.
+ "price": { # The price for the product.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "condition": "A String", # Condition or state of the item.
+ },
+ "unitTax": { # Unit tax for the line item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "quantityOrdered": 42, # Number of items ordered.
+ "shippingDetails": { # Details of the requested shipping for the line item.
+ "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
+ "method": { # Details of the shipping method.
+ "minDaysInTransit": 42, # Minimum transit time.
+ "carrier": "A String", # The carrier for the shipping. Optional.
+ "methodName": "A String", # The name of the shipping method.
+ "maxDaysInTransit": 42, # Maximum transit time.
+ },
+ "shipByDate": "A String", # The ship by date, in ISO 8601 format.
+ },
+ },
+ ],
+ "paymentMethod": { # The details of the payment method.
+ "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
+ "type": "A String", # The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder.
+ "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
+ "lastFourDigits": "A String", # The last four digits of the card number.
+ "predefinedBillingAddress": "A String", # The billing address.
+ },
+ },
+ "templateName": "A String", # The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "orderId": "A String", # The ID of the newly created test order.
+ "kind": "content#ordersCreateTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse".
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="custombatch">custombatch(body)</code>
+ <pre>Retrieves or modifies multiple orders in a single request.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "entries": [ # The request entries to be processed in the batch.
+ {
+ "orderId": "A String", # The ID of the order. Required for all methods beside getByMerchantOrderId.
+ "merchantOrderId": "A String", # The merchant order id. Required for updateMerchantOrderId and getByMerchantOrderId methods.
+ "shipLineItems": { # Required for shipLineItems method.
+ "lineItems": [ # Line items to ship.
+ {
+ "lineItemId": "A String", # The id of the line item that is shipped.
+ "quantity": 42, # The quantity that is shipped.
+ },
+ ],
+ "carrier": "A String", # The carrier handling the shipment.
+ "trackingId": "A String", # The tracking id for the shipment.
+ "shipmentId": "A String", # The ID of the shipment.
+ },
+ "updateShipment": { # Required for updateShipment method.
+ "status": "A String", # New status for the shipment. Not updated if missing.
+ "carrier": "A String", # The carrier handling the shipment. Not updated if missing.
+ "trackingId": "A String", # The tracking id for the shipment. Not updated if missing.
+ "shipmentId": "A String", # The ID of the shipment.
+ },
+ "method": "A String", # The method to apply.
+ "batchId": 42, # An entry ID, unique within the batch request.
+ "cancelLineItem": { # Required for cancelLineItem method.
+ "amount": { # Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "reasonText": "A String", # The explanation of the reason.
+ "reason": "A String", # The reason for the cancellation.
+ "lineItemId": "A String", # The ID of the line item to cancel.
+ "quantity": 42, # The quantity to cancel.
+ },
+ "refund": { # Required for refund method.
+ "amount": { # The amount that is refunded.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "reasonText": "A String", # The explanation of the reason.
+ "reason": "A String", # The reason for the refund.
+ },
+ "cancel": { # Required for cancel method.
+ "reason": "A String", # The reason for the cancellation.
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ "returnLineItem": { # Required for returnLineItem method.
+ "reason": "A String", # The reason for the return.
+ "reasonText": "A String", # The explanation of the reason.
+ "lineItemId": "A String", # The ID of the line item to return.
+ "quantity": 42, # The quantity to return.
+ },
+ "merchantId": "A String", # The ID of the managing account.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#ordersCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponse".
+ "entries": [ # The result of the execution of the batch requests.
+ {
+ "batchId": 42, # The ID of the request entry this entry responds to.
+ "kind": "content#ordersCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponseEntry".
+ "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
+ "message": "A String", # The message of the first error in errors.
+ "code": 42, # The HTTP status of the first error in errors.
+ "errors": [ # A list of errors.
+ { # An error returned by the API.
+ "reason": "A String", # The error code.
+ "domain": "A String", # The domain of the error.
+ "message": "A String", # A description of the error.
+ },
+ ],
+ },
+ "order": { # The retrieved order. Only defined if the method is get and if the request was successful.
+ "customer": { # The details of the customer who placed the order.
+ "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
+ "fullName": "A String", # Full name of the customer.
+ "email": "A String", # Email address of the customer.
+ },
+ "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are here.
+ {
+ "benefits": [
+ {
+ "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
+ "A String",
+ ],
+ "discount": { # The discount in the order price when the promotion is applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
+ "taxImpact": { # The impact on tax when the promotion is applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
+ },
+ ],
+ "longTitle": "A String", # The full title of the promotion.
+ "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
+ "redemptionChannel": "A String", # Indicates that the promotion is valid online.
+ "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
+ "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
+ # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
+ "id": "A String", # The unique ID of the promotion.
+ },
+ ],
+ "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
+ "shippingCostTax": { # The tax for the total shipping cost.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shipments": [ # Shipments of the order.
+ {
+ "status": "A String", # The status of the shipment.
+ "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
+ "carrier": "A String", # The carrier handling the shipment.
+ "trackingId": "A String", # The tracking id for the shipment.
+ "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
+ "lineItems": [ # The line items that are shipped.
+ {
+ "lineItemId": "A String", # The id of the line item that is shipped.
+ "quantity": 42, # The quantity that is shipped.
+ },
+ ],
+ "id": "A String", # The id of the shipment.
+ },
+ ],
+ "refunds": [ # Refunds for the order.
+ {
+ "amount": { # The amount that is refunded.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "reason": "A String", # The reason for the refund.
+ "actor": "A String", # The actor that created the refund.
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "paymentMethod": { # The details of the payment method.
+ "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
+ "lastFourDigits": "A String", # The last four digits of the card number.
+ "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
+ "phoneNumber": "A String", # The billing phone number.
+ "billingAddress": { # The billing address.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "country": "A String", # CLDR country code (e.g. "US").
+ "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+ # John Smith
+ # 1600 Amphitheatre Parkway
+ # Mountain View, CA, 94043
+ # United States
+ "A String",
+ ],
+ "streetAddress": [ # Street-level part of the address.
+ "A String",
+ ],
+ "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+ "recipientName": "A String", # Name of the recipient.
+ "isPostOfficeBox": True or False, # Whether the address is a post office box.
+ "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+ },
+ "type": "A String", # The type of instrument (VISA, Mastercard, etc).
+ },
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "acknowledged": True or False, # Whether the order was acknowledged.
+ "paymentStatus": "A String", # The status of the payment.
+ "merchantId": "A String",
+ "merchantOrderId": "A String", # Merchant-provided id of the order.
+ "shippingOption": "A String", # The requested shipping option.
+ "status": "A String", # The status of the order.
+ "deliveryDetails": { # The details for the delivery.
+ "phoneNumber": "A String", # The phone number of the person receiving the delivery.
+ "address": { # The delivery address
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "country": "A String", # CLDR country code (e.g. "US").
+ "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+ # John Smith
+ # 1600 Amphitheatre Parkway
+ # Mountain View, CA, 94043
+ # United States
+ "A String",
+ ],
+ "streetAddress": [ # Street-level part of the address.
+ "A String",
+ ],
+ "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+ "recipientName": "A String", # Name of the recipient.
+ "isPostOfficeBox": True or False, # Whether the address is a post office box.
+ "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+ },
+ },
+ "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
+ "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
+ "lineItems": [ # Line items that are ordered.
+ {
+ "product": { # Product data from the time of the order placement.
+ "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+ "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
+ "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+ "title": "A String", # The title of the product.
+ "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
+ "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
+ {
+ "dimension": "A String", # The dimension of the variant.
+ "value": "A String", # The value for the dimension.
+ },
+ ],
+ "brand": "A String", # Brand of the item.
+ "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "offerId": "A String", # An identifier of the item.
+ "price": { # Price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "imageLink": "A String", # URL of an image of the item.
+ "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
+ "channel": "A String", # The item's channel (online or local).
+ "id": "A String", # The REST id of the product.
+ "condition": "A String", # Condition or state of the item.
+ },
+ "quantityDelivered": 42, # Number of items delivered.
+ "returnInfo": { # Details of the return policy for the line item.
+ "policyUrl": "A String", # URL of the item return policy.
+ "isReturnable": True or False, # Whether the item is returnable.
+ "daysToReturn": 42, # How many days later the item can be returned.
+ },
+ "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "quantityPending": 42, # Number of items pending.
+ "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "cancellations": [ # Cancellations of the line item.
+ {
+ "reason": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.
+ "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
+ "reasonText": "A String", # The explanation of the reason.
+ "actor": "A String", # The actor that created the cancellation.
+ "quantity": 42, # The quantity that was canceled.
+ },
+ ],
+ "quantityCanceled": 42, # Number of items canceled.
+ "quantityOrdered": 42, # Number of items ordered.
+ "returns": [ # Returns of the line item.
+ {
+ "reason": "A String", # The reason for the return.
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "reasonText": "A String", # The explanation of the reason.
+ "actor": "A String", # The actor that created the refund.
+ "quantity": 42, # Quantity that is returned.
+ },
+ ],
+ "quantityShipped": 42, # Number of items shipped.
+ "quantityReturned": 42, # Number of items returned.
+ "id": "A String", # The id of the line item.
+ "shippingDetails": { # Details of the requested shipping for the line item.
+ "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
+ "method": { # Details of the shipping method.
+ "minDaysInTransit": 42, # Minimum transit time.
+ "carrier": "A String", # The carrier for the shipping. Optional.
+ "methodName": "A String", # The name of the shipping method.
+ "maxDaysInTransit": 42, # Maximum transit time.
+ },
+ "shipByDate": "A String", # The ship by date, in ISO 8601 format.
+ },
+ },
+ ],
+ "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "id": "A String", # The REST id of the order. Globally unique.
+ },
+ "executionStatus": "A String", # The status of the execution. Only defined if the method is not get or getByMerchantOrderId and if the request was successful.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(merchantId, orderId)</code>
+ <pre>Retrieves an order from your Merchant Center account.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ orderId: string, The ID of the order. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "customer": { # The details of the customer who placed the order.
+ "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
+ "fullName": "A String", # Full name of the customer.
+ "email": "A String", # Email address of the customer.
+ },
+ "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are here.
+ {
+ "benefits": [
+ {
+ "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
+ "A String",
+ ],
+ "discount": { # The discount in the order price when the promotion is applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
+ "taxImpact": { # The impact on tax when the promotion is applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
+ },
+ ],
+ "longTitle": "A String", # The full title of the promotion.
+ "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
+ "redemptionChannel": "A String", # Indicates that the promotion is valid online.
+ "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
+ "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
+ # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
+ "id": "A String", # The unique ID of the promotion.
+ },
+ ],
+ "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
+ "shippingCostTax": { # The tax for the total shipping cost.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shipments": [ # Shipments of the order.
+ {
+ "status": "A String", # The status of the shipment.
+ "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
+ "carrier": "A String", # The carrier handling the shipment.
+ "trackingId": "A String", # The tracking id for the shipment.
+ "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
+ "lineItems": [ # The line items that are shipped.
+ {
+ "lineItemId": "A String", # The id of the line item that is shipped.
+ "quantity": 42, # The quantity that is shipped.
+ },
+ ],
+ "id": "A String", # The id of the shipment.
+ },
+ ],
+ "refunds": [ # Refunds for the order.
+ {
+ "amount": { # The amount that is refunded.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "reason": "A String", # The reason for the refund.
+ "actor": "A String", # The actor that created the refund.
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "paymentMethod": { # The details of the payment method.
+ "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
+ "lastFourDigits": "A String", # The last four digits of the card number.
+ "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
+ "phoneNumber": "A String", # The billing phone number.
+ "billingAddress": { # The billing address.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "country": "A String", # CLDR country code (e.g. "US").
+ "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+ # John Smith
+ # 1600 Amphitheatre Parkway
+ # Mountain View, CA, 94043
+ # United States
+ "A String",
+ ],
+ "streetAddress": [ # Street-level part of the address.
+ "A String",
+ ],
+ "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+ "recipientName": "A String", # Name of the recipient.
+ "isPostOfficeBox": True or False, # Whether the address is a post office box.
+ "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+ },
+ "type": "A String", # The type of instrument (VISA, Mastercard, etc).
+ },
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "acknowledged": True or False, # Whether the order was acknowledged.
+ "paymentStatus": "A String", # The status of the payment.
+ "merchantId": "A String",
+ "merchantOrderId": "A String", # Merchant-provided id of the order.
+ "shippingOption": "A String", # The requested shipping option.
+ "status": "A String", # The status of the order.
+ "deliveryDetails": { # The details for the delivery.
+ "phoneNumber": "A String", # The phone number of the person receiving the delivery.
+ "address": { # The delivery address
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "country": "A String", # CLDR country code (e.g. "US").
+ "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+ # John Smith
+ # 1600 Amphitheatre Parkway
+ # Mountain View, CA, 94043
+ # United States
+ "A String",
+ ],
+ "streetAddress": [ # Street-level part of the address.
+ "A String",
+ ],
+ "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+ "recipientName": "A String", # Name of the recipient.
+ "isPostOfficeBox": True or False, # Whether the address is a post office box.
+ "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+ },
+ },
+ "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
+ "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
+ "lineItems": [ # Line items that are ordered.
+ {
+ "product": { # Product data from the time of the order placement.
+ "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+ "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
+ "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+ "title": "A String", # The title of the product.
+ "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
+ "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
+ {
+ "dimension": "A String", # The dimension of the variant.
+ "value": "A String", # The value for the dimension.
+ },
+ ],
+ "brand": "A String", # Brand of the item.
+ "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "offerId": "A String", # An identifier of the item.
+ "price": { # Price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "imageLink": "A String", # URL of an image of the item.
+ "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
+ "channel": "A String", # The item's channel (online or local).
+ "id": "A String", # The REST id of the product.
+ "condition": "A String", # Condition or state of the item.
+ },
+ "quantityDelivered": 42, # Number of items delivered.
+ "returnInfo": { # Details of the return policy for the line item.
+ "policyUrl": "A String", # URL of the item return policy.
+ "isReturnable": True or False, # Whether the item is returnable.
+ "daysToReturn": 42, # How many days later the item can be returned.
+ },
+ "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "quantityPending": 42, # Number of items pending.
+ "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "cancellations": [ # Cancellations of the line item.
+ {
+ "reason": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.
+ "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
+ "reasonText": "A String", # The explanation of the reason.
+ "actor": "A String", # The actor that created the cancellation.
+ "quantity": 42, # The quantity that was canceled.
+ },
+ ],
+ "quantityCanceled": 42, # Number of items canceled.
+ "quantityOrdered": 42, # Number of items ordered.
+ "returns": [ # Returns of the line item.
+ {
+ "reason": "A String", # The reason for the return.
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "reasonText": "A String", # The explanation of the reason.
+ "actor": "A String", # The actor that created the refund.
+ "quantity": 42, # Quantity that is returned.
+ },
+ ],
+ "quantityShipped": 42, # Number of items shipped.
+ "quantityReturned": 42, # Number of items returned.
+ "id": "A String", # The id of the line item.
+ "shippingDetails": { # Details of the requested shipping for the line item.
+ "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
+ "method": { # Details of the shipping method.
+ "minDaysInTransit": 42, # Minimum transit time.
+ "carrier": "A String", # The carrier for the shipping. Optional.
+ "methodName": "A String", # The name of the shipping method.
+ "maxDaysInTransit": 42, # Maximum transit time.
+ },
+ "shipByDate": "A String", # The ship by date, in ISO 8601 format.
+ },
+ },
+ ],
+ "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "id": "A String", # The REST id of the order. Globally unique.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getbymerchantorderid">getbymerchantorderid(merchantId, merchantOrderId)</code>
+ <pre>Retrieves an order using merchant order id.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ merchantOrderId: string, The merchant order id to be looked for. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#ordersGetByMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse".
+ "order": { # The requested order.
+ "customer": { # The details of the customer who placed the order.
+ "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
+ "fullName": "A String", # Full name of the customer.
+ "email": "A String", # Email address of the customer.
+ },
+ "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are here.
+ {
+ "benefits": [
+ {
+ "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
+ "A String",
+ ],
+ "discount": { # The discount in the order price when the promotion is applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
+ "taxImpact": { # The impact on tax when the promotion is applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
+ },
+ ],
+ "longTitle": "A String", # The full title of the promotion.
+ "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
+ "redemptionChannel": "A String", # Indicates that the promotion is valid online.
+ "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
+ "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
+ # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
+ "id": "A String", # The unique ID of the promotion.
+ },
+ ],
+ "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
+ "shippingCostTax": { # The tax for the total shipping cost.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shipments": [ # Shipments of the order.
+ {
+ "status": "A String", # The status of the shipment.
+ "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
+ "carrier": "A String", # The carrier handling the shipment.
+ "trackingId": "A String", # The tracking id for the shipment.
+ "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
+ "lineItems": [ # The line items that are shipped.
+ {
+ "lineItemId": "A String", # The id of the line item that is shipped.
+ "quantity": 42, # The quantity that is shipped.
+ },
+ ],
+ "id": "A String", # The id of the shipment.
+ },
+ ],
+ "refunds": [ # Refunds for the order.
+ {
+ "amount": { # The amount that is refunded.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "reason": "A String", # The reason for the refund.
+ "actor": "A String", # The actor that created the refund.
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "paymentMethod": { # The details of the payment method.
+ "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
+ "lastFourDigits": "A String", # The last four digits of the card number.
+ "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
+ "phoneNumber": "A String", # The billing phone number.
+ "billingAddress": { # The billing address.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "country": "A String", # CLDR country code (e.g. "US").
+ "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+ # John Smith
+ # 1600 Amphitheatre Parkway
+ # Mountain View, CA, 94043
+ # United States
+ "A String",
+ ],
+ "streetAddress": [ # Street-level part of the address.
+ "A String",
+ ],
+ "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+ "recipientName": "A String", # Name of the recipient.
+ "isPostOfficeBox": True or False, # Whether the address is a post office box.
+ "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+ },
+ "type": "A String", # The type of instrument (VISA, Mastercard, etc).
+ },
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "acknowledged": True or False, # Whether the order was acknowledged.
+ "paymentStatus": "A String", # The status of the payment.
+ "merchantId": "A String",
+ "merchantOrderId": "A String", # Merchant-provided id of the order.
+ "shippingOption": "A String", # The requested shipping option.
+ "status": "A String", # The status of the order.
+ "deliveryDetails": { # The details for the delivery.
+ "phoneNumber": "A String", # The phone number of the person receiving the delivery.
+ "address": { # The delivery address
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "country": "A String", # CLDR country code (e.g. "US").
+ "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+ # John Smith
+ # 1600 Amphitheatre Parkway
+ # Mountain View, CA, 94043
+ # United States
+ "A String",
+ ],
+ "streetAddress": [ # Street-level part of the address.
+ "A String",
+ ],
+ "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+ "recipientName": "A String", # Name of the recipient.
+ "isPostOfficeBox": True or False, # Whether the address is a post office box.
+ "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+ },
+ },
+ "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
+ "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
+ "lineItems": [ # Line items that are ordered.
+ {
+ "product": { # Product data from the time of the order placement.
+ "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+ "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
+ "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+ "title": "A String", # The title of the product.
+ "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
+ "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
+ {
+ "dimension": "A String", # The dimension of the variant.
+ "value": "A String", # The value for the dimension.
+ },
+ ],
+ "brand": "A String", # Brand of the item.
+ "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "offerId": "A String", # An identifier of the item.
+ "price": { # Price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "imageLink": "A String", # URL of an image of the item.
+ "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
+ "channel": "A String", # The item's channel (online or local).
+ "id": "A String", # The REST id of the product.
+ "condition": "A String", # Condition or state of the item.
+ },
+ "quantityDelivered": 42, # Number of items delivered.
+ "returnInfo": { # Details of the return policy for the line item.
+ "policyUrl": "A String", # URL of the item return policy.
+ "isReturnable": True or False, # Whether the item is returnable.
+ "daysToReturn": 42, # How many days later the item can be returned.
+ },
+ "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "quantityPending": 42, # Number of items pending.
+ "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "cancellations": [ # Cancellations of the line item.
+ {
+ "reason": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.
+ "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
+ "reasonText": "A String", # The explanation of the reason.
+ "actor": "A String", # The actor that created the cancellation.
+ "quantity": 42, # The quantity that was canceled.
+ },
+ ],
+ "quantityCanceled": 42, # Number of items canceled.
+ "quantityOrdered": 42, # Number of items ordered.
+ "returns": [ # Returns of the line item.
+ {
+ "reason": "A String", # The reason for the return.
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "reasonText": "A String", # The explanation of the reason.
+ "actor": "A String", # The actor that created the refund.
+ "quantity": 42, # Quantity that is returned.
+ },
+ ],
+ "quantityShipped": 42, # Number of items shipped.
+ "quantityReturned": 42, # Number of items returned.
+ "id": "A String", # The id of the line item.
+ "shippingDetails": { # Details of the requested shipping for the line item.
+ "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
+ "method": { # Details of the shipping method.
+ "minDaysInTransit": 42, # Minimum transit time.
+ "carrier": "A String", # The carrier for the shipping. Optional.
+ "methodName": "A String", # The name of the shipping method.
+ "maxDaysInTransit": 42, # Maximum transit time.
+ },
+ "shipByDate": "A String", # The ship by date, in ISO 8601 format.
+ },
+ },
+ ],
+ "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "id": "A String", # The REST id of the order. Globally unique.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="gettestordertemplate">gettestordertemplate(merchantId, templateName)</code>
+ <pre>Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ templateName: string, The name of the template to retrieve. (required)
+ Allowed values
+ template1 -
+ template1a -
+ template1b -
+ template2 -
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#ordersGetTestOrderTemplateResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse".
+ "template": { # The requested test order template.
+ "customer": { # The details of the customer who placed the order.
+ "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow. Optional.
+ "fullName": "A String", # Full name of the customer.
+ "email": "A String", # Email address of the customer.
+ },
+ "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are here.
+ {
+ "benefits": [
+ {
+ "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
+ "A String",
+ ],
+ "discount": { # The discount in the order price when the promotion is applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
+ "taxImpact": { # The impact on tax when the promotion is applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
+ },
+ ],
+ "longTitle": "A String", # The full title of the promotion.
+ "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
+ "redemptionChannel": "A String", # Indicates that the promotion is valid online.
+ "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
+ "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
+ # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
+ "id": "A String", # The unique ID of the promotion.
+ },
+ ],
+ "kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "content#testOrder".
+ "shippingCostTax": { # The tax for the total shipping cost.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "predefinedDeliveryAddress": "A String", # Identifier of one of the predefined delivery addresses for the delivery.
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shippingOption": "A String", # The requested shipping option.
+ "lineItems": [ # Line items that are ordered. At least one line item must be provided.
+ {
+ "returnInfo": { # Details of the return policy for the line item.
+ "policyUrl": "A String", # URL of the item return policy.
+ "isReturnable": True or False, # Whether the item is returnable.
+ "daysToReturn": 42, # How many days later the item can be returned.
+ },
+ "product": { # Product data from the time of the order placement.
+ "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+ "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+ "title": "A String", # The title of the product.
+ "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
+ "variantAttributes": [ # Variant attributes for the item. Optional.
+ {
+ "dimension": "A String", # The dimension of the variant.
+ "value": "A String", # The value for the dimension.
+ },
+ ],
+ "brand": "A String", # Brand of the item.
+ "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
+ "offerId": "A String", # An identifier of the item.
+ "imageLink": "A String", # URL of an image of the item.
+ "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
+ "channel": "A String", # The item's channel.
+ "price": { # The price for the product.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "condition": "A String", # Condition or state of the item.
+ },
+ "unitTax": { # Unit tax for the line item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "quantityOrdered": 42, # Number of items ordered.
+ "shippingDetails": { # Details of the requested shipping for the line item.
+ "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
+ "method": { # Details of the shipping method.
+ "minDaysInTransit": 42, # Minimum transit time.
+ "carrier": "A String", # The carrier for the shipping. Optional.
+ "methodName": "A String", # The name of the shipping method.
+ "maxDaysInTransit": 42, # Maximum transit time.
+ },
+ "shipByDate": "A String", # The ship by date, in ISO 8601 format.
+ },
+ },
+ ],
+ "paymentMethod": { # The details of the payment method.
+ "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
+ "type": "A String", # The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder.
+ "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
+ "lastFourDigits": "A String", # The last four digits of the card number.
+ "predefinedBillingAddress": "A String", # The billing address.
+ },
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(merchantId, orderBy=None, pageToken=None, placedDateEnd=None, acknowledged=None, maxResults=None, placedDateStart=None, statuses=None)</code>
+ <pre>Lists the orders in your Merchant Center account.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ orderBy: string, The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.
+ Allowed values
+ placedDate asc -
+ placedDate desc -
+ pageToken: string, The token returned by the previous request.
+ placedDateEnd: string, Obtains orders placed before this date (exclusively), in ISO 8601 format.
+ acknowledged: boolean, Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.
+We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.
+ maxResults: integer, The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
+Known issue: All List calls will return all Orders without limit regardless of the value of this field.
+ placedDateStart: string, Obtains orders placed after this date (inclusively), in ISO 8601 format.
+ statuses: string, Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled. (repeated)
+ Allowed values
+ active -
+ canceled -
+ completed -
+ delivered -
+ inProgress -
+ partiallyDelivered -
+ partiallyReturned -
+ partiallyShipped -
+ pendingShipment -
+ returned -
+ shipped -
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # The token for the retrieval of the next page of orders.
+ "kind": "content#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse".
+ "resources": [
+ {
+ "customer": { # The details of the customer who placed the order.
+ "explicitMarketingPreference": True or False, # If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
+ "fullName": "A String", # Full name of the customer.
+ "email": "A String", # Email address of the customer.
+ },
+ "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are here.
+ {
+ "benefits": [
+ {
+ "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
+ "A String",
+ ],
+ "discount": { # The discount in the order price when the promotion is applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
+ "taxImpact": { # The impact on tax when the promotion is applied.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
+ },
+ ],
+ "longTitle": "A String", # The full title of the promotion.
+ "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
+ "redemptionChannel": "A String", # Indicates that the promotion is valid online.
+ "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
+ "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
+ # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
+ "id": "A String", # The unique ID of the promotion.
+ },
+ ],
+ "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
+ "shippingCostTax": { # The tax for the total shipping cost.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "shipments": [ # Shipments of the order.
+ {
+ "status": "A String", # The status of the shipment.
+ "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
+ "carrier": "A String", # The carrier handling the shipment.
+ "trackingId": "A String", # The tracking id for the shipment.
+ "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
+ "lineItems": [ # The line items that are shipped.
+ {
+ "lineItemId": "A String", # The id of the line item that is shipped.
+ "quantity": 42, # The quantity that is shipped.
+ },
+ ],
+ "id": "A String", # The id of the shipment.
+ },
+ ],
+ "refunds": [ # Refunds for the order.
+ {
+ "amount": { # The amount that is refunded.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "reason": "A String", # The reason for the refund.
+ "actor": "A String", # The actor that created the refund.
+ "reasonText": "A String", # The explanation of the reason.
+ },
+ ],
+ "paymentMethod": { # The details of the payment method.
+ "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
+ "lastFourDigits": "A String", # The last four digits of the card number.
+ "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
+ "phoneNumber": "A String", # The billing phone number.
+ "billingAddress": { # The billing address.
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "country": "A String", # CLDR country code (e.g. "US").
+ "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+ # John Smith
+ # 1600 Amphitheatre Parkway
+ # Mountain View, CA, 94043
+ # United States
+ "A String",
+ ],
+ "streetAddress": [ # Street-level part of the address.
+ "A String",
+ ],
+ "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+ "recipientName": "A String", # Name of the recipient.
+ "isPostOfficeBox": True or False, # Whether the address is a post office box.
+ "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+ },
+ "type": "A String", # The type of instrument (VISA, Mastercard, etc).
+ },
+ "shippingCost": { # The total cost of shipping for all items.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "acknowledged": True or False, # Whether the order was acknowledged.
+ "paymentStatus": "A String", # The status of the payment.
+ "merchantId": "A String",
+ "merchantOrderId": "A String", # Merchant-provided id of the order.
+ "shippingOption": "A String", # The requested shipping option.
+ "status": "A String", # The status of the order.
+ "deliveryDetails": { # The details for the delivery.
+ "phoneNumber": "A String", # The phone number of the person receiving the delivery.
+ "address": { # The delivery address
+ "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+ "country": "A String", # CLDR country code (e.g. "US").
+ "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+ # John Smith
+ # 1600 Amphitheatre Parkway
+ # Mountain View, CA, 94043
+ # United States
+ "A String",
+ ],
+ "streetAddress": [ # Street-level part of the address.
+ "A String",
+ ],
+ "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+ "recipientName": "A String", # Name of the recipient.
+ "isPostOfficeBox": True or False, # Whether the address is a post office box.
+ "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+ },
+ },
+ "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
+ "channelType": "A String", # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
+ "lineItems": [ # Line items that are ordered.
+ {
+ "product": { # Product data from the time of the order placement.
+ "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+ "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
+ "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+ "title": "A String", # The title of the product.
+ "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
+ "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
+ {
+ "dimension": "A String", # The dimension of the variant.
+ "value": "A String", # The value for the dimension.
+ },
+ ],
+ "brand": "A String", # Brand of the item.
+ "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "offerId": "A String", # An identifier of the item.
+ "price": { # Price of the item.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "imageLink": "A String", # URL of an image of the item.
+ "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
+ "channel": "A String", # The item's channel (online or local).
+ "id": "A String", # The REST id of the product.
+ "condition": "A String", # Condition or state of the item.
+ },
+ "quantityDelivered": 42, # Number of items delivered.
+ "returnInfo": { # Details of the return policy for the line item.
+ "policyUrl": "A String", # URL of the item return policy.
+ "isReturnable": True or False, # Whether the item is returnable.
+ "daysToReturn": 42, # How many days later the item can be returned.
+ },
+ "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "quantityPending": 42, # Number of items pending.
+ "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "cancellations": [ # Cancellations of the line item.
+ {
+ "reason": "A String", # The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads.
+ "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
+ "reasonText": "A String", # The explanation of the reason.
+ "actor": "A String", # The actor that created the cancellation.
+ "quantity": 42, # The quantity that was canceled.
+ },
+ ],
+ "quantityCanceled": 42, # Number of items canceled.
+ "quantityOrdered": 42, # Number of items ordered.
+ "returns": [ # Returns of the line item.
+ {
+ "reason": "A String", # The reason for the return.
+ "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+ "reasonText": "A String", # The explanation of the reason.
+ "actor": "A String", # The actor that created the refund.
+ "quantity": 42, # Quantity that is returned.
+ },
+ ],
+ "quantityShipped": 42, # Number of items shipped.
+ "quantityReturned": 42, # Number of items returned.
+ "id": "A String", # The id of the line item.
+ "shippingDetails": { # Details of the requested shipping for the line item.
+ "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
+ "method": { # Details of the shipping method.
+ "minDaysInTransit": 42, # Minimum transit time.
+ "carrier": "A String", # The carrier for the shipping. Optional.
+ "methodName": "A String", # The name of the shipping method.
+ "maxDaysInTransit": 42, # Maximum transit time.
+ },
+ "shipByDate": "A String", # The ship by date, in ISO 8601 format.
+ },
+ },
+ ],
+ "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "id": "A String", # The REST id of the order. Globally unique.
+ },
+ ],
+ }</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="refund">refund(merchantId, orderId, body)</code>
+ <pre>Refund a portion of the order, up to the full amount paid.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ orderId: string, The ID of the order to refund. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "amount": { # The amount that is refunded.
+ "currency": "A String", # The currency of the price.
+ "value": "A String", # The price represented as a number.
+ },
+ "reasonText": "A String", # The explanation of the reason.
+ "reason": "A String", # The reason for the refund.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#ordersRefundResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundResponse".
+ "executionStatus": "A String", # The status of the execution.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="returnlineitem">returnlineitem(merchantId, orderId, body)</code>
+ <pre>Returns a line item.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ orderId: string, The ID of the order. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "reason": "A String", # The reason for the return.
+ "quantity": 42, # The quantity to return.
+ "reasonText": "A String", # The explanation of the reason.
+ "lineItemId": "A String", # The ID of the line item to return.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#ordersReturnLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnLineItemResponse".
+ "executionStatus": "A String", # The status of the execution.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="shiplineitems">shiplineitems(merchantId, orderId, body)</code>
+ <pre>Marks line item(s) as shipped.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ orderId: string, The ID of the order. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "lineItems": [ # Line items to ship.
+ {
+ "lineItemId": "A String", # The id of the line item that is shipped.
+ "quantity": 42, # The quantity that is shipped.
+ },
+ ],
+ "carrier": "A String", # The carrier handling the shipment.
+ "shipmentId": "A String", # The ID of the shipment.
+ "trackingId": "A String", # The tracking id for the shipment.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#ordersShipLineItemsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse".
+ "executionStatus": "A String", # The status of the execution.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="updatemerchantorderid">updatemerchantorderid(merchantId, orderId, body)</code>
+ <pre>Updates the merchant order ID for a given order.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ orderId: string, The ID of the order. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "merchantOrderId": "A String", # The merchant order id to be assigned to the order. Must be unique per merchant.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#ordersUpdateMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse".
+ "executionStatus": "A String", # The status of the execution.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="updateshipment">updateshipment(merchantId, orderId, body)</code>
+ <pre>Updates a shipment's status, carrier, and/or tracking ID.
+
+Args:
+ merchantId: string, The ID of the managing account. (required)
+ orderId: string, The ID of the order. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "status": "A String", # New status for the shipment. Not updated if missing.
+ "shipmentId": "A String", # The ID of the shipment.
+ "carrier": "A String", # The carrier handling the shipment. Not updated if missing.
+ "trackingId": "A String", # The tracking id for the shipment. Not updated if missing.
+ "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "content#ordersUpdateShipmentResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse".
+ "executionStatus": "A String", # The status of the execution.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/coordinate_v1.customFieldDef.html b/docs/dyn/coordinate_v1.customFieldDef.html
deleted file mode 100644
index 80c1ac1..0000000
--- a/docs/dyn/coordinate_v1.customFieldDef.html
+++ /dev/null
@@ -1,113 +0,0 @@
-<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="coordinate_v1.html">Google Maps Coordinate API</a> . <a href="coordinate_v1.customFieldDef.html">customFieldDef</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(teamId)</a></code></p>
-<p class="firstline">Retrieves a list of custom field definitions for a team.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(teamId)</code>
- <pre>Retrieves a list of custom field definitions for a team.
-
-Args:
- teamId: string, Team ID (required)
-
-Returns:
- An object of the form:
-
- { # Collection of custom field definitions for a team.
- "items": [ # Collection of custom field definitions in a team.
- { # Custom field definition.
- "kind": "coordinate#customFieldDef", # Identifies this object as a custom field definition.
- "enumitems": [ # List of enum items for this custom field. Populated only if the field type is enum. Enum fields appear as 'lists' in the Coordinate web and mobile UI.
- { # Enum Item definition.
- "active": True or False, # Whether the enum item is active. Jobs may contain inactive enum values; however, setting an enum to an inactive value when creating or updating a job will result in a 500 error.
- "kind": "coordinate#enumItemDef", # Identifies this object as an enum item definition.
- "value": "A String", # Custom field value.
- },
- ],
- "name": "A String", # Custom field name.
- "enabled": True or False, # Whether the field is enabled.
- "requiredForCheckout": True or False, # Whether the field is required for checkout.
- "type": "A String", # Custom field type.
- "id": "A String", # Custom field id.
- },
- ],
- "kind": "coordinate#customFieldDefList", # Identifies this object as a collection of custom field definitions in a team.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/coordinate_v1.jobs.html b/docs/dyn/coordinate_v1.jobs.html
deleted file mode 100644
index 4949fcd..0000000
--- a/docs/dyn/coordinate_v1.jobs.html
+++ /dev/null
@@ -1,780 +0,0 @@
-<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="coordinate_v1.html">Google Maps Coordinate API</a> . <a href="coordinate_v1.jobs.html">jobs</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(teamId, jobId)</a></code></p>
-<p class="firstline">Retrieves a job, including all the changes made to the job.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(teamId, address, lat, lng, title, body, customerName=None, assignee=None, customerPhoneNumber=None, note=None, customField=None)</a></code></p>
-<p class="firstline">Inserts a new job. Only the state field of the job should be set.</p>
-<p class="toc_element">
- <code><a href="#list">list(teamId, pageToken=None, minModifiedTimestampMs=None, maxResults=None, omitJobChanges=None)</a></code></p>
-<p class="firstline">Retrieves jobs created or modified since the given timestamp.</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(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None, customField=None)</a></code></p>
-<p class="firstline">Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None, customField=None)</a></code></p>
-<p class="firstline">Updates a job. Fields that are set in the job state will be updated.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(teamId, jobId)</code>
- <pre>Retrieves a job, including all the changes made to the job.
-
-Args:
- teamId: string, Team ID (required)
- jobId: string, Job number (required)
-
-Returns:
- An object of the form:
-
- { # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(teamId, address, lat, lng, title, body, customerName=None, assignee=None, customerPhoneNumber=None, note=None, customField=None)</code>
- <pre>Inserts a new job. Only the state field of the job should be set.
-
-Args:
- teamId: string, Team ID (required)
- address: string, Job address as newline (Unix) separated string (required)
- lat: number, The latitude coordinate of this job's location. (required)
- lng: number, The longitude coordinate of this job's location. (required)
- title: string, Job title (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }
-
- customerName: string, Customer name
- assignee: string, Assignee email address, or empty string to unassign.
- customerPhoneNumber: string, Customer phone number
- note: string, Job note as newline (Unix) separated string
- customField: string, Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500. (repeated)
-
-Returns:
- An object of the form:
-
- { # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(teamId, pageToken=None, minModifiedTimestampMs=None, maxResults=None, omitJobChanges=None)</code>
- <pre>Retrieves jobs created or modified since the given timestamp.
-
-Args:
- teamId: string, Team ID (required)
- pageToken: string, Continuation token
- minModifiedTimestampMs: string, Minimum time a job was modified in milliseconds since epoch.
- maxResults: integer, Maximum number of results to return in one page.
- omitJobChanges: boolean, Whether to omit detail job history information.
-
-Returns:
- An object of the form:
-
- { # Response from a List Jobs request.
- "nextPageToken": "A String", # A token to provide to get the next page of results.
- "items": [ # Jobs in the collection.
- { # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "kind": "coordinate#jobList", # Identifies this object as a list of jobs.
- }</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(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None, customField=None)</code>
- <pre>Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics.
-
-Args:
- teamId: string, Team ID (required)
- jobId: string, Job number (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }
-
- customerName: string, Customer name
- assignee: string, Assignee email address, or empty string to unassign.
- customerPhoneNumber: string, Customer phone number
- lng: number, The longitude coordinate of this job's location.
- note: string, Job note as newline (Unix) separated string
- title: string, Job title
- progress: string, Job progress
- Allowed values
- COMPLETED - Completed
- IN_PROGRESS - In progress
- NOT_ACCEPTED - Not accepted
- NOT_STARTED - Not started
- OBSOLETE - Obsolete
- address: string, Job address as newline (Unix) separated string
- lat: number, The latitude coordinate of this job's location.
- customField: string, Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500. (repeated)
-
-Returns:
- An object of the form:
-
- { # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None, customField=None)</code>
- <pre>Updates a job. Fields that are set in the job state will be updated.
-
-Args:
- teamId: string, Team ID (required)
- jobId: string, Job number (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }
-
- customerName: string, Customer name
- assignee: string, Assignee email address, or empty string to unassign.
- customerPhoneNumber: string, Customer phone number
- lng: number, The longitude coordinate of this job's location.
- note: string, Job note as newline (Unix) separated string
- title: string, Job title
- progress: string, Job progress
- Allowed values
- COMPLETED - Completed
- IN_PROGRESS - In progress
- NOT_ACCEPTED - Not accepted
- NOT_STARTED - Not started
- OBSOLETE - Obsolete
- address: string, Job address as newline (Unix) separated string
- lat: number, The latitude coordinate of this job's location.
- customField: string, Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500. (repeated)
-
-Returns:
- An object of the form:
-
- { # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/coordinate_v1.location.html b/docs/dyn/coordinate_v1.location.html
deleted file mode 100644
index 131ec9d..0000000
--- a/docs/dyn/coordinate_v1.location.html
+++ /dev/null
@@ -1,132 +0,0 @@
-<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="coordinate_v1.html">Google Maps Coordinate API</a> . <a href="coordinate_v1.location.html">location</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(teamId, workerEmail, startTimestampMs, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Retrieves a list of locations for a worker.</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(teamId, workerEmail, startTimestampMs, pageToken=None, maxResults=None)</code>
- <pre>Retrieves a list of locations for a worker.
-
-Args:
- teamId: string, Team ID (required)
- workerEmail: string, Worker email address. (required)
- startTimestampMs: string, Start timestamp in milliseconds since the epoch. (required)
- pageToken: string, Continuation token
- maxResults: integer, Maximum number of results to return in one page.
-
-Returns:
- An object of the form:
-
- { # Response from a List Locations request.
- "nextPageToken": "A String", # A token to provide to get the next page of results.
- "items": [ # Locations in the collection.
- { # Recorded location of a worker.
- "latitude": 3.14, # Latitude.
- "collectionTime": "A String", # The collection time in milliseconds since the epoch.
- "confidenceRadius": 3.14, # The location accuracy in meters. This is the radius of a 95% confidence interval around the location measurement.
- "kind": "coordinate#locationRecord", # Identifies this object as a location.
- "longitude": 3.14, # Longitude.
- },
- ],
- "kind": "coordinate#locationList", # Identifies this object as a list of locations.
- "tokenPagination": { # Pagination information. # Pagination information for token pagination.
- "nextPageToken": "A String", # A token to provide to get the next page of results.
- "previousPageToken": "A String", # A token to provide to get the previous page of results.
- "kind": "coordinate#tokenPagination", # Identifies this object as pagination information.
- },
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/coordinate_v1.schedule.html b/docs/dyn/coordinate_v1.schedule.html
deleted file mode 100644
index 7a68369..0000000
--- a/docs/dyn/coordinate_v1.schedule.html
+++ /dev/null
@@ -1,177 +0,0 @@
-<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="coordinate_v1.html">Google Maps Coordinate API</a> . <a href="coordinate_v1.schedule.html">schedule</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <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, 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, 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">
- <code class="details" id="get">get(teamId, jobId)</code>
- <pre>Retrieves the schedule for a job.
-
-Args:
- teamId: string, Team ID (required)
- jobId: string, Job number (required)
-
-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.
- "endTime": "A String", # Scheduled end time in milliseconds since epoch.
- }</pre>
-</div>
-
-<div class="method">
- <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:
- teamId: string, Team ID (required)
- jobId: string, Job number (required)
- body: object, The request body. (required)
- 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.
- "endTime": "A String", # Scheduled end time in milliseconds since epoch.
- }
-
- 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.
- "endTime": "A String", # Scheduled end time in milliseconds since epoch.
- }</pre>
-</div>
-
-<div class="method">
- <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:
- teamId: string, Team ID (required)
- jobId: string, Job number (required)
- body: object, The request body. (required)
- 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.
- "endTime": "A String", # Scheduled end time in milliseconds since epoch.
- }
-
- 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.
- "endTime": "A String", # Scheduled end time in milliseconds since epoch.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/coordinate_v1.team.html b/docs/dyn/coordinate_v1.team.html
deleted file mode 100644
index 9d1ff2f..0000000
--- a/docs/dyn/coordinate_v1.team.html
+++ /dev/null
@@ -1,105 +0,0 @@
-<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="coordinate_v1.html">Google Maps Coordinate API</a> . <a href="coordinate_v1.team.html">team</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(admin=None, worker=None, dispatcher=None)</a></code></p>
-<p class="firstline">Retrieves a list of teams for a user.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(admin=None, worker=None, dispatcher=None)</code>
- <pre>Retrieves a list of teams for a user.
-
-Args:
- admin: boolean, Whether to include teams for which the user has the Admin role.
- worker: boolean, Whether to include teams for which the user has the Worker role.
- dispatcher: boolean, Whether to include teams for which the user has the Dispatcher role.
-
-Returns:
- An object of the form:
-
- { # Response from a List Teams request.
- "items": [ # Teams in the collection.
- { # A Coordinate team.
- "kind": "coordinate#team", # Identifies this object as a team.
- "id": "A String", # Team id, as found in a coordinate team url e.g. https://coordinate.google.com/f/xyz where "xyz" is the team id.
- "name": "A String", # Team name
- },
- ],
- "kind": "coordinate#teamList", # Identifies this object as a list of teams.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/coordinate_v1.worker.html b/docs/dyn/coordinate_v1.worker.html
deleted file mode 100644
index 4ddfd65..0000000
--- a/docs/dyn/coordinate_v1.worker.html
+++ /dev/null
@@ -1,102 +0,0 @@
-<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="coordinate_v1.html">Google Maps Coordinate API</a> . <a href="coordinate_v1.worker.html">worker</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(teamId)</a></code></p>
-<p class="firstline">Retrieves a list of workers in a team.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(teamId)</code>
- <pre>Retrieves a list of workers in a team.
-
-Args:
- teamId: string, Team ID (required)
-
-Returns:
- An object of the form:
-
- { # Response from a List Workers request.
- "items": [ # Workers in the collection.
- { # A worker in a Coordinate team.
- "kind": "coordinate#worker", # Identifies this object as a worker.
- "id": "A String", # Worker email address. If a worker has been deleted from your team, the email address will appear as DELETED_USER.
- },
- ],
- "kind": "coordinate#workerList", # Identifies this object as a list of workers.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dataflow_v1b4.html b/docs/dyn/dataflow_v1b4.html
deleted file mode 100644
index ee8523d..0000000
--- a/docs/dyn/dataflow_v1b4.html
+++ /dev/null
@@ -1,77 +0,0 @@
-<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="dataflow_v1b4.html">Google Dataflow API</a></h1>
-<h2>Instance Methods</h2>
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dataflow_v1beta3.html b/docs/dyn/dataflow_v1beta3.html
deleted file mode 100644
index 365d7d9..0000000
--- a/docs/dyn/dataflow_v1beta3.html
+++ /dev/null
@@ -1,82 +0,0 @@
-<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="dataflow_v1beta3.html">Google Dataflow API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="dataflow_v1beta3.v1b3.html">v1b3()</a></code>
-</p>
-<p class="firstline">Returns the v1b3 Resource.</p>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dataflow_v1beta3.v1b3.projects.jobs.html b/docs/dyn/dataflow_v1beta3.v1b3.projects.jobs.html
deleted file mode 100644
index db0374e..0000000
--- a/docs/dyn/dataflow_v1beta3.v1b3.projects.jobs.html
+++ /dev/null
@@ -1,1120 +0,0 @@
-<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="dataflow_v1beta3.html">Google Dataflow API</a> . <a href="dataflow_v1beta3.v1b3.html">v1b3</a> . <a href="dataflow_v1beta3.v1b3.projects.html">projects</a> . <a href="dataflow_v1beta3.v1b3.projects.jobs.html">jobs</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="dataflow_v1beta3.v1b3.projects.jobs.messages.html">messages()</a></code>
-</p>
-<p class="firstline">Returns the messages Resource.</p>
-
-<p class="toc_element">
- <code><a href="dataflow_v1beta3.v1b3.projects.jobs.workItems.html">workItems()</a></code>
-</p>
-<p class="firstline">Returns the workItems Resource.</p>
-
-<p class="toc_element">
- <code><a href="#create">create(projectId, body, view=None)</a></code></p>
-<p class="firstline">Creates a dataflow job.</p>
-<p class="toc_element">
- <code><a href="#get">get(projectId, jobId, view=None)</a></code></p>
-<p class="firstline">Gets the state of the specified dataflow job.</p>
-<p class="toc_element">
- <code><a href="#getMetrics">getMetrics(projectId, jobId, startTime=None)</a></code></p>
-<p class="firstline">Request the job status.</p>
-<p class="toc_element">
- <code><a href="#list">list(projectId, pageToken=None, pageSize=None, view=None)</a></code></p>
-<p class="firstline">List the jobs of a 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(projectId, jobId, body)</a></code></p>
-<p class="firstline">Updates the state of an existing dataflow job. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(projectId, jobId, body)</a></code></p>
-<p class="firstline">Updates the state of an existing dataflow job.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(projectId, body, view=None)</code>
- <pre>Creates a dataflow job.
-
-Args:
- projectId: string, A parameter (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "requestedState": "A String",
- "name": "A String",
- "projectId": "A String",
- "createTime": "A String",
- "environment": {
- "version": {
- "a_key": "",
- },
- "workerPools": [
- {
- "diskSourceImage": "A String",
- "teardownPolicy": "A String",
- "kind": "A String",
- "packages": [
- {
- "location": "A String",
- "name": "A String",
- },
- ],
- "machineType": "A String",
- "zone": "A String",
- "onHostMaintenance": "A String",
- "taskrunnerSettings": {
- "workflowFileName": "A String",
- "logUploadLocation": "A String",
- "commandlinesFileName": "A String",
- "alsologtostderr": True or False,
- "vmId": "A String",
- "baseTaskDir": "A String",
- "continueOnException": True or False,
- "baseUrl": "A String",
- "parallelWorkerSettings": {
- "reportingEnabled": True or False,
- "shuffleServicePath": "A String",
- "workerId": "A String",
- "baseUrl": "A String",
- "servicePath": "A String",
- "tempStoragePrefix": "A String",
- },
- "oauthScopes": [
- "A String",
- ],
- "taskGroup": "A String",
- "languageHint": "A String",
- "logToSerialconsole": True or False,
- "streamingWorkerMainClass": "A String",
- "logDir": "A String",
- "dataflowApiVersion": "A String",
- "taskUser": "A String",
- "harnessCommand": "A String",
- "tempStoragePrefix": "A String",
- },
- "diskSizeGb": 42,
- "numWorkers": 42,
- "defaultPackageSet": "A String",
- "metadata": {
- "a_key": "A String",
- },
- "autoscalingSettings": {
- "maxNumWorkers": 42,
- "algorithm": "A String",
- },
- "dataDisks": [
- {
- "mountPoint": "A String",
- "sizeGb": 42,
- "diskType": "A String",
- },
- ],
- },
- ],
- "dataset": "A String",
- "experiments": [
- "A String",
- ],
- "sdkPipelineOptions": {
- "a_key": "",
- },
- "userAgent": {
- "a_key": "",
- },
- "clusterManagerApiService": "A String",
- "tempStoragePrefix": "A String",
- },
- "steps": [
- {
- "kind": "A String",
- "name": "A String",
- "properties": {
- "a_key": "",
- },
- },
- ],
- "currentStateTime": "A String",
- "type": "A String",
- "id": "A String",
- "currentState": "A String",
- "executionInfo": {
- "stages": {
- "a_key": {
- "stepName": [
- "A String",
- ],
- },
- },
- },
-}
-
- view: string, A parameter
- Allowed values
- JOB_VIEW_ALL -
- JOB_VIEW_SUMMARY -
- JOB_VIEW_UNKNOWN -
-
-Returns:
- An object of the form:
-
- {
- "requestedState": "A String",
- "name": "A String",
- "projectId": "A String",
- "createTime": "A String",
- "environment": {
- "version": {
- "a_key": "",
- },
- "workerPools": [
- {
- "diskSourceImage": "A String",
- "teardownPolicy": "A String",
- "kind": "A String",
- "packages": [
- {
- "location": "A String",
- "name": "A String",
- },
- ],
- "machineType": "A String",
- "zone": "A String",
- "onHostMaintenance": "A String",
- "taskrunnerSettings": {
- "workflowFileName": "A String",
- "logUploadLocation": "A String",
- "commandlinesFileName": "A String",
- "alsologtostderr": True or False,
- "vmId": "A String",
- "baseTaskDir": "A String",
- "continueOnException": True or False,
- "baseUrl": "A String",
- "parallelWorkerSettings": {
- "reportingEnabled": True or False,
- "shuffleServicePath": "A String",
- "workerId": "A String",
- "baseUrl": "A String",
- "servicePath": "A String",
- "tempStoragePrefix": "A String",
- },
- "oauthScopes": [
- "A String",
- ],
- "taskGroup": "A String",
- "languageHint": "A String",
- "logToSerialconsole": True or False,
- "streamingWorkerMainClass": "A String",
- "logDir": "A String",
- "dataflowApiVersion": "A String",
- "taskUser": "A String",
- "harnessCommand": "A String",
- "tempStoragePrefix": "A String",
- },
- "diskSizeGb": 42,
- "numWorkers": 42,
- "defaultPackageSet": "A String",
- "metadata": {
- "a_key": "A String",
- },
- "autoscalingSettings": {
- "maxNumWorkers": 42,
- "algorithm": "A String",
- },
- "dataDisks": [
- {
- "mountPoint": "A String",
- "sizeGb": 42,
- "diskType": "A String",
- },
- ],
- },
- ],
- "dataset": "A String",
- "experiments": [
- "A String",
- ],
- "sdkPipelineOptions": {
- "a_key": "",
- },
- "userAgent": {
- "a_key": "",
- },
- "clusterManagerApiService": "A String",
- "tempStoragePrefix": "A String",
- },
- "steps": [
- {
- "kind": "A String",
- "name": "A String",
- "properties": {
- "a_key": "",
- },
- },
- ],
- "currentStateTime": "A String",
- "type": "A String",
- "id": "A String",
- "currentState": "A String",
- "executionInfo": {
- "stages": {
- "a_key": {
- "stepName": [
- "A String",
- ],
- },
- },
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(projectId, jobId, view=None)</code>
- <pre>Gets the state of the specified dataflow job.
-
-Args:
- projectId: string, A parameter (required)
- jobId: string, A parameter (required)
- view: string, A parameter
- Allowed values
- JOB_VIEW_ALL -
- JOB_VIEW_SUMMARY -
- JOB_VIEW_UNKNOWN -
-
-Returns:
- An object of the form:
-
- {
- "requestedState": "A String",
- "name": "A String",
- "projectId": "A String",
- "createTime": "A String",
- "environment": {
- "version": {
- "a_key": "",
- },
- "workerPools": [
- {
- "diskSourceImage": "A String",
- "teardownPolicy": "A String",
- "kind": "A String",
- "packages": [
- {
- "location": "A String",
- "name": "A String",
- },
- ],
- "machineType": "A String",
- "zone": "A String",
- "onHostMaintenance": "A String",
- "taskrunnerSettings": {
- "workflowFileName": "A String",
- "logUploadLocation": "A String",
- "commandlinesFileName": "A String",
- "alsologtostderr": True or False,
- "vmId": "A String",
- "baseTaskDir": "A String",
- "continueOnException": True or False,
- "baseUrl": "A String",
- "parallelWorkerSettings": {
- "reportingEnabled": True or False,
- "shuffleServicePath": "A String",
- "workerId": "A String",
- "baseUrl": "A String",
- "servicePath": "A String",
- "tempStoragePrefix": "A String",
- },
- "oauthScopes": [
- "A String",
- ],
- "taskGroup": "A String",
- "languageHint": "A String",
- "logToSerialconsole": True or False,
- "streamingWorkerMainClass": "A String",
- "logDir": "A String",
- "dataflowApiVersion": "A String",
- "taskUser": "A String",
- "harnessCommand": "A String",
- "tempStoragePrefix": "A String",
- },
- "diskSizeGb": 42,
- "numWorkers": 42,
- "defaultPackageSet": "A String",
- "metadata": {
- "a_key": "A String",
- },
- "autoscalingSettings": {
- "maxNumWorkers": 42,
- "algorithm": "A String",
- },
- "dataDisks": [
- {
- "mountPoint": "A String",
- "sizeGb": 42,
- "diskType": "A String",
- },
- ],
- },
- ],
- "dataset": "A String",
- "experiments": [
- "A String",
- ],
- "sdkPipelineOptions": {
- "a_key": "",
- },
- "userAgent": {
- "a_key": "",
- },
- "clusterManagerApiService": "A String",
- "tempStoragePrefix": "A String",
- },
- "steps": [
- {
- "kind": "A String",
- "name": "A String",
- "properties": {
- "a_key": "",
- },
- },
- ],
- "currentStateTime": "A String",
- "type": "A String",
- "id": "A String",
- "currentState": "A String",
- "executionInfo": {
- "stages": {
- "a_key": {
- "stepName": [
- "A String",
- ],
- },
- },
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="getMetrics">getMetrics(projectId, jobId, startTime=None)</code>
- <pre>Request the job status.
-
-Args:
- projectId: string, A parameter (required)
- jobId: string, A parameter (required)
- startTime: string, A parameter
-
-Returns:
- An object of the form:
-
- {
- "metrics": [
- {
- "meanCount": "",
- "kind": "A String",
- "set": "",
- "name": {
- "origin": "A String",
- "name": "A String",
- "context": {
- "a_key": "A String",
- },
- },
- "meanSum": "",
- "cumulative": True or False,
- "updateTime": "A String",
- "scalar": "",
- "internal": "",
- },
- ],
- "metricTime": "A String",
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(projectId, pageToken=None, pageSize=None, view=None)</code>
- <pre>List the jobs of a project
-
-Args:
- projectId: string, A parameter (required)
- pageToken: string, A parameter
- pageSize: integer, A parameter
- view: string, A parameter
- Allowed values
- JOB_VIEW_ALL -
- JOB_VIEW_SUMMARY -
- JOB_VIEW_UNKNOWN -
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String",
- "jobs": [
- {
- "requestedState": "A String",
- "name": "A String",
- "projectId": "A String",
- "createTime": "A String",
- "environment": {
- "version": {
- "a_key": "",
- },
- "workerPools": [
- {
- "diskSourceImage": "A String",
- "teardownPolicy": "A String",
- "kind": "A String",
- "packages": [
- {
- "location": "A String",
- "name": "A String",
- },
- ],
- "machineType": "A String",
- "zone": "A String",
- "onHostMaintenance": "A String",
- "taskrunnerSettings": {
- "workflowFileName": "A String",
- "logUploadLocation": "A String",
- "commandlinesFileName": "A String",
- "alsologtostderr": True or False,
- "vmId": "A String",
- "baseTaskDir": "A String",
- "continueOnException": True or False,
- "baseUrl": "A String",
- "parallelWorkerSettings": {
- "reportingEnabled": True or False,
- "shuffleServicePath": "A String",
- "workerId": "A String",
- "baseUrl": "A String",
- "servicePath": "A String",
- "tempStoragePrefix": "A String",
- },
- "oauthScopes": [
- "A String",
- ],
- "taskGroup": "A String",
- "languageHint": "A String",
- "logToSerialconsole": True or False,
- "streamingWorkerMainClass": "A String",
- "logDir": "A String",
- "dataflowApiVersion": "A String",
- "taskUser": "A String",
- "harnessCommand": "A String",
- "tempStoragePrefix": "A String",
- },
- "diskSizeGb": 42,
- "numWorkers": 42,
- "defaultPackageSet": "A String",
- "metadata": {
- "a_key": "A String",
- },
- "autoscalingSettings": {
- "maxNumWorkers": 42,
- "algorithm": "A String",
- },
- "dataDisks": [
- {
- "mountPoint": "A String",
- "sizeGb": 42,
- "diskType": "A String",
- },
- ],
- },
- ],
- "dataset": "A String",
- "experiments": [
- "A String",
- ],
- "sdkPipelineOptions": {
- "a_key": "",
- },
- "userAgent": {
- "a_key": "",
- },
- "clusterManagerApiService": "A String",
- "tempStoragePrefix": "A String",
- },
- "steps": [
- {
- "kind": "A String",
- "name": "A String",
- "properties": {
- "a_key": "",
- },
- },
- ],
- "currentStateTime": "A String",
- "type": "A String",
- "id": "A String",
- "currentState": "A String",
- "executionInfo": {
- "stages": {
- "a_key": {
- "stepName": [
- "A String",
- ],
- },
- },
- },
- },
- ],
- }</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(projectId, jobId, body)</code>
- <pre>Updates the state of an existing dataflow job. This method supports patch semantics.
-
-Args:
- projectId: string, A parameter (required)
- jobId: string, A parameter (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "requestedState": "A String",
- "name": "A String",
- "projectId": "A String",
- "createTime": "A String",
- "environment": {
- "version": {
- "a_key": "",
- },
- "workerPools": [
- {
- "diskSourceImage": "A String",
- "teardownPolicy": "A String",
- "kind": "A String",
- "packages": [
- {
- "location": "A String",
- "name": "A String",
- },
- ],
- "machineType": "A String",
- "zone": "A String",
- "onHostMaintenance": "A String",
- "taskrunnerSettings": {
- "workflowFileName": "A String",
- "logUploadLocation": "A String",
- "commandlinesFileName": "A String",
- "alsologtostderr": True or False,
- "vmId": "A String",
- "baseTaskDir": "A String",
- "continueOnException": True or False,
- "baseUrl": "A String",
- "parallelWorkerSettings": {
- "reportingEnabled": True or False,
- "shuffleServicePath": "A String",
- "workerId": "A String",
- "baseUrl": "A String",
- "servicePath": "A String",
- "tempStoragePrefix": "A String",
- },
- "oauthScopes": [
- "A String",
- ],
- "taskGroup": "A String",
- "languageHint": "A String",
- "logToSerialconsole": True or False,
- "streamingWorkerMainClass": "A String",
- "logDir": "A String",
- "dataflowApiVersion": "A String",
- "taskUser": "A String",
- "harnessCommand": "A String",
- "tempStoragePrefix": "A String",
- },
- "diskSizeGb": 42,
- "numWorkers": 42,
- "defaultPackageSet": "A String",
- "metadata": {
- "a_key": "A String",
- },
- "autoscalingSettings": {
- "maxNumWorkers": 42,
- "algorithm": "A String",
- },
- "dataDisks": [
- {
- "mountPoint": "A String",
- "sizeGb": 42,
- "diskType": "A String",
- },
- ],
- },
- ],
- "dataset": "A String",
- "experiments": [
- "A String",
- ],
- "sdkPipelineOptions": {
- "a_key": "",
- },
- "userAgent": {
- "a_key": "",
- },
- "clusterManagerApiService": "A String",
- "tempStoragePrefix": "A String",
- },
- "steps": [
- {
- "kind": "A String",
- "name": "A String",
- "properties": {
- "a_key": "",
- },
- },
- ],
- "currentStateTime": "A String",
- "type": "A String",
- "id": "A String",
- "currentState": "A String",
- "executionInfo": {
- "stages": {
- "a_key": {
- "stepName": [
- "A String",
- ],
- },
- },
- },
-}
-
-
-Returns:
- An object of the form:
-
- {
- "requestedState": "A String",
- "name": "A String",
- "projectId": "A String",
- "createTime": "A String",
- "environment": {
- "version": {
- "a_key": "",
- },
- "workerPools": [
- {
- "diskSourceImage": "A String",
- "teardownPolicy": "A String",
- "kind": "A String",
- "packages": [
- {
- "location": "A String",
- "name": "A String",
- },
- ],
- "machineType": "A String",
- "zone": "A String",
- "onHostMaintenance": "A String",
- "taskrunnerSettings": {
- "workflowFileName": "A String",
- "logUploadLocation": "A String",
- "commandlinesFileName": "A String",
- "alsologtostderr": True or False,
- "vmId": "A String",
- "baseTaskDir": "A String",
- "continueOnException": True or False,
- "baseUrl": "A String",
- "parallelWorkerSettings": {
- "reportingEnabled": True or False,
- "shuffleServicePath": "A String",
- "workerId": "A String",
- "baseUrl": "A String",
- "servicePath": "A String",
- "tempStoragePrefix": "A String",
- },
- "oauthScopes": [
- "A String",
- ],
- "taskGroup": "A String",
- "languageHint": "A String",
- "logToSerialconsole": True or False,
- "streamingWorkerMainClass": "A String",
- "logDir": "A String",
- "dataflowApiVersion": "A String",
- "taskUser": "A String",
- "harnessCommand": "A String",
- "tempStoragePrefix": "A String",
- },
- "diskSizeGb": 42,
- "numWorkers": 42,
- "defaultPackageSet": "A String",
- "metadata": {
- "a_key": "A String",
- },
- "autoscalingSettings": {
- "maxNumWorkers": 42,
- "algorithm": "A String",
- },
- "dataDisks": [
- {
- "mountPoint": "A String",
- "sizeGb": 42,
- "diskType": "A String",
- },
- ],
- },
- ],
- "dataset": "A String",
- "experiments": [
- "A String",
- ],
- "sdkPipelineOptions": {
- "a_key": "",
- },
- "userAgent": {
- "a_key": "",
- },
- "clusterManagerApiService": "A String",
- "tempStoragePrefix": "A String",
- },
- "steps": [
- {
- "kind": "A String",
- "name": "A String",
- "properties": {
- "a_key": "",
- },
- },
- ],
- "currentStateTime": "A String",
- "type": "A String",
- "id": "A String",
- "currentState": "A String",
- "executionInfo": {
- "stages": {
- "a_key": {
- "stepName": [
- "A String",
- ],
- },
- },
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(projectId, jobId, body)</code>
- <pre>Updates the state of an existing dataflow job.
-
-Args:
- projectId: string, A parameter (required)
- jobId: string, A parameter (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "requestedState": "A String",
- "name": "A String",
- "projectId": "A String",
- "createTime": "A String",
- "environment": {
- "version": {
- "a_key": "",
- },
- "workerPools": [
- {
- "diskSourceImage": "A String",
- "teardownPolicy": "A String",
- "kind": "A String",
- "packages": [
- {
- "location": "A String",
- "name": "A String",
- },
- ],
- "machineType": "A String",
- "zone": "A String",
- "onHostMaintenance": "A String",
- "taskrunnerSettings": {
- "workflowFileName": "A String",
- "logUploadLocation": "A String",
- "commandlinesFileName": "A String",
- "alsologtostderr": True or False,
- "vmId": "A String",
- "baseTaskDir": "A String",
- "continueOnException": True or False,
- "baseUrl": "A String",
- "parallelWorkerSettings": {
- "reportingEnabled": True or False,
- "shuffleServicePath": "A String",
- "workerId": "A String",
- "baseUrl": "A String",
- "servicePath": "A String",
- "tempStoragePrefix": "A String",
- },
- "oauthScopes": [
- "A String",
- ],
- "taskGroup": "A String",
- "languageHint": "A String",
- "logToSerialconsole": True or False,
- "streamingWorkerMainClass": "A String",
- "logDir": "A String",
- "dataflowApiVersion": "A String",
- "taskUser": "A String",
- "harnessCommand": "A String",
- "tempStoragePrefix": "A String",
- },
- "diskSizeGb": 42,
- "numWorkers": 42,
- "defaultPackageSet": "A String",
- "metadata": {
- "a_key": "A String",
- },
- "autoscalingSettings": {
- "maxNumWorkers": 42,
- "algorithm": "A String",
- },
- "dataDisks": [
- {
- "mountPoint": "A String",
- "sizeGb": 42,
- "diskType": "A String",
- },
- ],
- },
- ],
- "dataset": "A String",
- "experiments": [
- "A String",
- ],
- "sdkPipelineOptions": {
- "a_key": "",
- },
- "userAgent": {
- "a_key": "",
- },
- "clusterManagerApiService": "A String",
- "tempStoragePrefix": "A String",
- },
- "steps": [
- {
- "kind": "A String",
- "name": "A String",
- "properties": {
- "a_key": "",
- },
- },
- ],
- "currentStateTime": "A String",
- "type": "A String",
- "id": "A String",
- "currentState": "A String",
- "executionInfo": {
- "stages": {
- "a_key": {
- "stepName": [
- "A String",
- ],
- },
- },
- },
-}
-
-
-Returns:
- An object of the form:
-
- {
- "requestedState": "A String",
- "name": "A String",
- "projectId": "A String",
- "createTime": "A String",
- "environment": {
- "version": {
- "a_key": "",
- },
- "workerPools": [
- {
- "diskSourceImage": "A String",
- "teardownPolicy": "A String",
- "kind": "A String",
- "packages": [
- {
- "location": "A String",
- "name": "A String",
- },
- ],
- "machineType": "A String",
- "zone": "A String",
- "onHostMaintenance": "A String",
- "taskrunnerSettings": {
- "workflowFileName": "A String",
- "logUploadLocation": "A String",
- "commandlinesFileName": "A String",
- "alsologtostderr": True or False,
- "vmId": "A String",
- "baseTaskDir": "A String",
- "continueOnException": True or False,
- "baseUrl": "A String",
- "parallelWorkerSettings": {
- "reportingEnabled": True or False,
- "shuffleServicePath": "A String",
- "workerId": "A String",
- "baseUrl": "A String",
- "servicePath": "A String",
- "tempStoragePrefix": "A String",
- },
- "oauthScopes": [
- "A String",
- ],
- "taskGroup": "A String",
- "languageHint": "A String",
- "logToSerialconsole": True or False,
- "streamingWorkerMainClass": "A String",
- "logDir": "A String",
- "dataflowApiVersion": "A String",
- "taskUser": "A String",
- "harnessCommand": "A String",
- "tempStoragePrefix": "A String",
- },
- "diskSizeGb": 42,
- "numWorkers": 42,
- "defaultPackageSet": "A String",
- "metadata": {
- "a_key": "A String",
- },
- "autoscalingSettings": {
- "maxNumWorkers": 42,
- "algorithm": "A String",
- },
- "dataDisks": [
- {
- "mountPoint": "A String",
- "sizeGb": 42,
- "diskType": "A String",
- },
- ],
- },
- ],
- "dataset": "A String",
- "experiments": [
- "A String",
- ],
- "sdkPipelineOptions": {
- "a_key": "",
- },
- "userAgent": {
- "a_key": "",
- },
- "clusterManagerApiService": "A String",
- "tempStoragePrefix": "A String",
- },
- "steps": [
- {
- "kind": "A String",
- "name": "A String",
- "properties": {
- "a_key": "",
- },
- },
- ],
- "currentStateTime": "A String",
- "type": "A String",
- "id": "A String",
- "currentState": "A String",
- "executionInfo": {
- "stages": {
- "a_key": {
- "stepName": [
- "A String",
- ],
- },
- },
- },
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dataflow_v1beta3.v1b3.projects.jobs.messages.html b/docs/dyn/dataflow_v1beta3.v1b3.projects.jobs.messages.html
deleted file mode 100644
index 4b65dd9..0000000
--- a/docs/dyn/dataflow_v1beta3.v1b3.projects.jobs.messages.html
+++ /dev/null
@@ -1,133 +0,0 @@
-<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="dataflow_v1beta3.html">Google Dataflow API</a> . <a href="dataflow_v1beta3.v1b3.html">v1b3</a> . <a href="dataflow_v1beta3.v1b3.projects.html">projects</a> . <a href="dataflow_v1beta3.v1b3.projects.jobs.html">jobs</a> . <a href="dataflow_v1beta3.v1b3.projects.jobs.messages.html">messages</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(projectId, jobId, pageSize=None, pageToken=None, startTime=None, endTime=None, minimumImportance=None)</a></code></p>
-<p class="firstline">Request the job status.</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(projectId, jobId, pageSize=None, pageToken=None, startTime=None, endTime=None, minimumImportance=None)</code>
- <pre>Request the job status.
-
-Args:
- projectId: string, A parameter (required)
- jobId: string, A parameter (required)
- pageSize: integer, A parameter
- pageToken: string, A parameter
- startTime: string, A parameter
- endTime: string, A parameter
- minimumImportance: string, A parameter
- Allowed values
- JOB_MESSAGE_DEBUG -
- JOB_MESSAGE_DETAILED -
- JOB_MESSAGE_ERROR -
- JOB_MESSAGE_IMPORTANCE_UNKNOWN -
- JOB_MESSAGE_WARNING -
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String",
- "jobMessages": [
- {
- "messageImportance": "A String",
- "messageText": "A String",
- "id": "A String",
- "time": "A String",
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dataflow_v1beta3.v1b3.projects.jobs.workItems.html b/docs/dyn/dataflow_v1beta3.v1b3.projects.jobs.workItems.html
deleted file mode 100644
index 8e70b61..0000000
--- a/docs/dyn/dataflow_v1beta3.v1b3.projects.jobs.workItems.html
+++ /dev/null
@@ -1,589 +0,0 @@
-<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="dataflow_v1beta3.html">Google Dataflow API</a> . <a href="dataflow_v1beta3.v1b3.html">v1b3</a> . <a href="dataflow_v1beta3.v1b3.projects.html">projects</a> . <a href="dataflow_v1beta3.v1b3.projects.jobs.html">jobs</a> . <a href="dataflow_v1beta3.v1b3.projects.jobs.workItems.html">workItems</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#lease">lease(projectId, jobId, body)</a></code></p>
-<p class="firstline">Leases a dataflow WorkItem to run.</p>
-<p class="toc_element">
- <code><a href="#reportStatus">reportStatus(projectId, jobId, body)</a></code></p>
-<p class="firstline">Reports the status of dataflow WorkItems leased by a worker.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="lease">lease(projectId, jobId, body)</code>
- <pre>Leases a dataflow WorkItem to run.
-
-Args:
- projectId: string, A parameter (required)
- jobId: string, A parameter (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "requestedLeaseDuration": "A String",
- "workItemTypes": [
- "A String",
- ],
- "workerCapabilities": [
- "A String",
- ],
- "currentWorkerTime": "A String",
- "workerId": "A String",
- }
-
-
-Returns:
- An object of the form:
-
- {
- "workItems": [
- {
- "configuration": "A String",
- "leaseExpireTime": "A String",
- "seqMapTask": {
- "inputs": [
- {
- "sources": [
- {
- "codec": {
- "a_key": "",
- },
- "baseSpecs": [
- {
- "a_key": "",
- },
- ],
- "spec": {
- "a_key": "",
- },
- "doesNotNeedSplitting": True or False,
- "metadata": {
- "infinite": True or False,
- "estimatedSizeBytes": "A String",
- "producesSortedKeys": True or False,
- },
- },
- ],
- "kind": {
- "a_key": "",
- },
- "tag": "A String",
- },
- ],
- "name": "A String",
- "stageName": "A String",
- "systemName": "A String",
- "userFn": {
- "a_key": "",
- },
- "outputInfos": [
- {
- "tag": "A String",
- "sink": {
- "codec": {
- "a_key": "",
- },
- "spec": {
- "a_key": "",
- },
- },
- },
- ],
- },
- "projectId": "A String",
- "sourceOperationTask": {
- "getMetadata": {
- "source": {
- "codec": {
- "a_key": "",
- },
- "baseSpecs": [
- {
- "a_key": "",
- },
- ],
- "spec": {
- "a_key": "",
- },
- "doesNotNeedSplitting": True or False,
- "metadata": {
- "infinite": True or False,
- "estimatedSizeBytes": "A String",
- "producesSortedKeys": True or False,
- },
- },
- },
- "split": {
- "source": {
- "codec": {
- "a_key": "",
- },
- "baseSpecs": [
- {
- "a_key": "",
- },
- ],
- "spec": {
- "a_key": "",
- },
- "doesNotNeedSplitting": True or False,
- "metadata": {
- "infinite": True or False,
- "estimatedSizeBytes": "A String",
- "producesSortedKeys": True or False,
- },
- },
- "options": {
- "desiredShardSizeBytes": "A String",
- },
- },
- },
- "mapTask": {
- "systemName": "A String",
- "stageName": "A String",
- "instructions": [
- {
- "name": "A String",
- "read": {
- "source": {
- "codec": {
- "a_key": "",
- },
- "baseSpecs": [
- {
- "a_key": "",
- },
- ],
- "spec": {
- "a_key": "",
- },
- "doesNotNeedSplitting": True or False,
- "metadata": {
- "infinite": True or False,
- "estimatedSizeBytes": "A String",
- "producesSortedKeys": True or False,
- },
- },
- },
- "outputs": [
- {
- "codec": {
- "a_key": "",
- },
- "name": "A String",
- },
- ],
- "partialGroupByKey": {
- "input": {
- "outputNum": 42,
- "producerInstructionIndex": 42,
- },
- "inputElementCodec": {
- "a_key": "",
- },
- },
- "write": {
- "input": {
- "outputNum": 42,
- "producerInstructionIndex": 42,
- },
- "sink": {
- "codec": {
- "a_key": "",
- },
- "spec": {
- "a_key": "",
- },
- },
- },
- "systemName": "A String",
- "flatten": {
- "inputs": [
- {
- "outputNum": 42,
- "producerInstructionIndex": 42,
- },
- ],
- },
- "parDo": {
- "sideInputs": [
- {
- "sources": [
- {
- "codec": {
- "a_key": "",
- },
- "baseSpecs": [
- {
- "a_key": "",
- },
- ],
- "spec": {
- "a_key": "",
- },
- "doesNotNeedSplitting": True or False,
- "metadata": {
- "infinite": True or False,
- "estimatedSizeBytes": "A String",
- "producesSortedKeys": True or False,
- },
- },
- ],
- "kind": {
- "a_key": "",
- },
- "tag": "A String",
- },
- ],
- "input": {
- "outputNum": 42,
- "producerInstructionIndex": 42,
- },
- "multiOutputInfos": [
- {
- "tag": "A String",
- },
- ],
- "numOutputs": 42,
- "userFn": {
- "a_key": "",
- },
- },
- },
- ],
- },
- "jobId": "A String",
- "reportStatusInterval": "A String",
- "streamingSetupTask": {
- "workerHarnessPort": 42,
- "streamingComputationTopology": {
- "computations": [
- {
- "inputs": [
- {
- "streamingStageLocation": {
- "streamId": "A String",
- },
- "pubsubLocation": {
- "idLabel": "A String",
- "topic": "A String",
- "subscription": "A String",
- "timestampLabel": "A String",
- "dropLateData": True or False,
- },
- },
- ],
- "computationId": "A String",
- "keyRanges": [
- {
- "start": "A String",
- "deliveryEndpoint": "A String",
- "end": "A String",
- "persistentDirectory": "A String",
- "dataDisk": "A String",
- },
- ],
- "outputs": [
- {
- "streamingStageLocation": {
- "streamId": "A String",
- },
- "pubsubLocation": {
- "idLabel": "A String",
- "topic": "A String",
- "subscription": "A String",
- "timestampLabel": "A String",
- "dropLateData": True or False,
- },
- },
- ],
- },
- ],
- "dataDiskAssignments": [
- {
- "vmInstance": "A String",
- "dataDisks": [
- "A String",
- ],
- },
- ],
- },
- "receiveWorkPort": 42,
- },
- "packages": [
- {
- "location": "A String",
- "name": "A String",
- },
- ],
- "shellTask": {
- "command": "A String",
- "exitCode": 42,
- },
- "id": "A String",
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="reportStatus">reportStatus(projectId, jobId, body)</code>
- <pre>Reports the status of dataflow WorkItems leased by a worker.
-
-Args:
- projectId: string, A parameter (required)
- jobId: string, A parameter (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "workerId": "A String",
- "currentWorkerTime": "A String",
- "workItemStatuses": [
- {
- "reportIndex": "A String",
- "errors": [
- {
- "message": "A String",
- "code": 42,
- "details": [
- {
- "a_key": "",
- },
- ],
- },
- ],
- "sourceOperationResponse": {
- "getMetadata": {
- "metadata": {
- "infinite": True or False,
- "estimatedSizeBytes": "A String",
- "producesSortedKeys": True or False,
- },
- },
- "split": {
- "outcome": "A String",
- "shards": [
- {
- "derivationMode": "A String",
- "source": {
- "codec": {
- "a_key": "",
- },
- "baseSpecs": [
- {
- "a_key": "",
- },
- ],
- "spec": {
- "a_key": "",
- },
- "doesNotNeedSplitting": True or False,
- "metadata": {
- "infinite": True or False,
- "estimatedSizeBytes": "A String",
- "producesSortedKeys": True or False,
- },
- },
- },
- ],
- },
- },
- "stopPosition": {
- "recordIndex": "A String",
- "end": True or False,
- "byteOffset": "A String",
- "key": "A String",
- "shufflePosition": "A String",
- },
- "sourceFork": {
- "primary": {
- "derivationMode": "A String",
- "source": {
- "codec": {
- "a_key": "",
- },
- "baseSpecs": [
- {
- "a_key": "",
- },
- ],
- "spec": {
- "a_key": "",
- },
- "doesNotNeedSplitting": True or False,
- "metadata": {
- "infinite": True or False,
- "estimatedSizeBytes": "A String",
- "producesSortedKeys": True or False,
- },
- },
- },
- "residual": {
- "derivationMode": "A String",
- "source": {
- "codec": {
- "a_key": "",
- },
- "baseSpecs": [
- {
- "a_key": "",
- },
- ],
- "spec": {
- "a_key": "",
- },
- "doesNotNeedSplitting": True or False,
- "metadata": {
- "infinite": True or False,
- "estimatedSizeBytes": "A String",
- "producesSortedKeys": True or False,
- },
- },
- },
- },
- "requestedLeaseDuration": "A String",
- "completed": True or False,
- "workItemId": "A String",
- "progress": {
- "position": {
- "recordIndex": "A String",
- "end": True or False,
- "byteOffset": "A String",
- "key": "A String",
- "shufflePosition": "A String",
- },
- "remainingTime": "A String",
- "percentComplete": 3.14,
- },
- "metricUpdates": [
- {
- "meanCount": "",
- "kind": "A String",
- "set": "",
- "name": {
- "origin": "A String",
- "name": "A String",
- "context": {
- "a_key": "A String",
- },
- },
- "meanSum": "",
- "cumulative": True or False,
- "updateTime": "A String",
- "scalar": "",
- "internal": "",
- },
- ],
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "workItemServiceStates": [
- {
- "suggestedStopPoint": {
- "position": {
- "recordIndex": "A String",
- "end": True or False,
- "byteOffset": "A String",
- "key": "A String",
- "shufflePosition": "A String",
- },
- "remainingTime": "A String",
- "percentComplete": 3.14,
- },
- "leaseExpireTime": "A String",
- "suggestedStopPosition": {
- "recordIndex": "A String",
- "end": True or False,
- "byteOffset": "A String",
- "key": "A String",
- "shufflePosition": "A String",
- },
- "reportStatusInterval": "A String",
- "harnessData": {
- "a_key": "",
- },
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dataproc_v1.media.html b/docs/dyn/dataproc_v1.media.html
deleted file mode 100644
index 68f253d..0000000
--- a/docs/dyn/dataproc_v1.media.html
+++ /dev/null
@@ -1,141 +0,0 @@
-<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="dataproc_v1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1.media.html">media</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#download">download(resourceName, x__xgafv=None)</a></code></p>
-<p class="firstline">Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.</p>
-<p class="toc_element">
- <code><a href="#download_media">download_media(resourceName, x__xgafv=None)</a></code></p>
-<p class="firstline">Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.</p>
-<p class="toc_element">
- <code><a href="#upload">upload(resourceName, body=None, media_body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Method for media upload. Upload is supported on the URI `/upload/v1/media/{+name}`.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="download">download(resourceName, x__xgafv=None)</code>
- <pre>Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.
-
-Args:
- resourceName: string, Name of the media that is being downloaded. See [][ByteStream.ReadRequest.resource_name]. (required)
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Media resource.
- "resourceName": "A String", # Name of the media resource.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="download_media">download_media(resourceName, x__xgafv=None)</code>
- <pre>Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.
-
-Args:
- resourceName: string, Name of the media that is being downloaded. See [][ByteStream.ReadRequest.resource_name]. (required)
- x__xgafv: string, V1 error format.
-
-Returns:
- The media object as a string.
-
- </pre>
-</div>
-
-<div class="method">
- <code class="details" id="upload">upload(resourceName, body=None, media_body=None, x__xgafv=None)</code>
- <pre>Method for media upload. Upload is supported on the URI `/upload/v1/media/{+name}`.
-
-Args:
- resourceName: string, Name of the media that is being downloaded. See [][ByteStream.ReadRequest.resource_name]. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Media resource.
- "resourceName": "A String", # Name of the media resource.
-}
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Media resource.
- "resourceName": "A String", # Name of the media resource.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/manager_v1beta2.html b/docs/dyn/dataproc_v1alpha1.html
similarity index 86%
rename from docs/dyn/manager_v1beta2.html
rename to docs/dyn/dataproc_v1alpha1.html
index 44fc028..3cee8f1 100644
--- a/docs/dyn/manager_v1beta2.html
+++ b/docs/dyn/dataproc_v1alpha1.html
@@ -72,17 +72,17 @@
</style>
-<h1><a href="manager_v1beta2.html">Deployment Manager API</a></h1>
+<h1><a href="dataproc_v1alpha1.html">Google Cloud Dataproc API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="manager_v1beta2.deployments.html">deployments()</a></code>
+ <code><a href="dataproc_v1alpha1.operations.html">operations()</a></code>
</p>
-<p class="firstline">Returns the deployments Resource.</p>
+<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
- <code><a href="manager_v1beta2.templates.html">templates()</a></code>
+ <code><a href="dataproc_v1alpha1.projects.html">projects()</a></code>
</p>
-<p class="firstline">Returns the templates Resource.</p>
+<p class="firstline">Returns the projects Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/dataproc_v1alpha1.operations.html b/docs/dyn/dataproc_v1alpha1.operations.html
new file mode 100644
index 0000000..186ad08
--- /dev/null
+++ b/docs/dyn/dataproc_v1alpha1.operations.html
@@ -0,0 +1,215 @@
+<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="dataproc_v1alpha1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1alpha1.operations.html">operations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#cancel">cancel(name, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients may use [Operations.GetOperation] or other methods to check whether the cancellation succeeded or the operation completed despite cancellation.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a long-running operation. It indicates the client is no longer interested in the operation result. It does not cancel the operation.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the latest state of a long-running operation. Clients may use this method to poll the operation result at intervals as recommended by the API service.</p>
+<p class="toc_element">
+ <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.</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="cancel">cancel(name, body, x__xgafv=None)</code>
+ <pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients may use [Operations.GetOperation] or other methods to check whether the cancellation succeeded or the operation completed despite cancellation.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>Deletes a long-running operation. It indicates the client is no longer interested in the operation result. It does not cancel the operation.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Gets the latest state of a long-running operation. Clients may use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The operation resource name. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
+ "response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ ],
+ },
+ "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
+ "name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
+ "metadata": { # Service-specific metadata associated with the operation.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The operation collection name. (required)
+ pageSize: integer, The standard List page size.
+ filter: string, [Required] A JSON object that contains filters for the list operation, in the format {"key1":"value1","key2":"value2", ..., }. Possible keys include project_id, cluster_name, and operation_state_matcher. If project_id is set, requests the list of operations that belong to the specified Google Cloud Platform project ID. This key is required. If cluster_name is set, requests the list of operations that were submitted to the specified cluster name. This key is optional. If operation_state_matcher is set, requests the list of operations that match one of the following status options: ALL, ACTIVE, or NON_ACTIVE.
+ pageToken: string, The standard List page token.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "operations": [ # A list of operations that match the specified filter in the request.
+ { # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
+ "response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ ],
+ },
+ "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
+ "name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
+ "metadata": { # Service-specific metadata associated with the operation.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ },
+ ],
+ "nextPageToken": "A String", # The standard List next-page token.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/dataflow_v1beta3.v1b3.html b/docs/dyn/dataproc_v1alpha1.projects.html
similarity index 79%
copy from docs/dyn/dataflow_v1beta3.v1b3.html
copy to docs/dyn/dataproc_v1alpha1.projects.html
index e81eb27..4216678 100644
--- a/docs/dyn/dataflow_v1beta3.v1b3.html
+++ b/docs/dyn/dataproc_v1alpha1.projects.html
@@ -72,11 +72,11 @@
</style>
-<h1><a href="dataflow_v1beta3.html">Google Dataflow API</a> . <a href="dataflow_v1beta3.v1b3.html">v1b3</a></h1>
+<h1><a href="dataproc_v1alpha1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1alpha1.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="dataflow_v1beta3.v1b3.projects.html">projects()</a></code>
+ <code><a href="dataproc_v1alpha1.projects.regions.html">regions()</a></code>
</p>
-<p class="firstline">Returns the projects Resource.</p>
+<p class="firstline">Returns the regions Resource.</p>
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dataproc_v1alpha1.projects.regions.clusters.html b/docs/dyn/dataproc_v1alpha1.projects.regions.clusters.html
new file mode 100644
index 0000000..3ac60d2
--- /dev/null
+++ b/docs/dyn/dataproc_v1alpha1.projects.regions.clusters.html
@@ -0,0 +1,736 @@
+<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="dataproc_v1alpha1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1alpha1.projects.html">projects</a> . <a href="dataproc_v1alpha1.projects.regions.html">regions</a> . <a href="dataproc_v1alpha1.projects.regions.clusters.html">clusters</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(projectId, region, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Request to create a cluster in a project.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(projectId, region, clusterName, x__xgafv=None)</a></code></p>
+<p class="firstline">Request to delete a cluster in a project.</p>
+<p class="toc_element">
+ <code><a href="#get">get(projectId, region, clusterName, x__xgafv=None)</a></code></p>
+<p class="firstline">Request to get the resource representation for a cluster in a project.</p>
+<p class="toc_element">
+ <code><a href="#list">list(projectId, region, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Request a list of all regions/{region}/clusters in a 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(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Request to update a cluster in a project.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(projectId, region, body, x__xgafv=None)</code>
+ <pre>Request to create a cluster in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+ region: string, [Required] The Dataproc region in which to handle the request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
+ "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ "statusHistory": [ # [Output-only] Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
+ "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
+ "configuration": { # The cluster configuration. # [Required] The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
+ "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
+ "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified it will default to latest version.
+ "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
+ "a_key": "A String",
+ },
+ },
+ "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of worker node disk options.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "workers": [ # [Deprecated] The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
+ "A String",
+ ],
+ "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
+ },
+ },
+ "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine configuration settings for all instances in a cluster.
+ "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`.
+ "tags": [ # The Google Compute Engine tags to add to all instances.
+ "A String",
+ ],
+ "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
+ "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`.
+ "serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
+ "A String",
+ ],
+ "metadata": { # The Google Compute Engine metadata entries to add to all instances.
+ "a_key": "A String",
+ },
+ },
+ "masterName": "A String", # [Deprecated] The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
+ "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
+ "gceConfiguration": { # [Deprecated] Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Deprecated] The Google Compute Engine configuration settings for cluster resources.
+ "machineTypeUri": "A String", # [Deprecated] The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "networkUri": "A String", # [Deprecated] The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default".
+ "zoneUri": "A String", # [Deprecated] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
+ "serviceAccountScopes": [ # [Deprecated] The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
+ "A String",
+ ],
+ "imageUri": "A String", # [Deprecated] The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ },
+ "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
+ },
+ },
+ "numWorkers": 42, # [Deprecated] The number of worker nodes in the cluster.
+ "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
+ { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
+ "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
+ "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
+ },
+ ],
+ "masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of master node disk options.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
+ },
+ },
+ },
+ "createTime": "A String", # [Output-only] The timestamp of cluster creation.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
+ "response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ ],
+ },
+ "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
+ "name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
+ "metadata": { # Service-specific metadata associated with the operation.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(projectId, region, clusterName, x__xgafv=None)</code>
+ <pre>Request to delete a cluster in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+ region: string, [Required] The Dataproc region in which to handle the request. (required)
+ clusterName: string, [Required] The cluster name. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
+ "response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ ],
+ },
+ "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
+ "name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
+ "metadata": { # Service-specific metadata associated with the operation.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(projectId, region, clusterName, x__xgafv=None)</code>
+ <pre>Request to get the resource representation for a cluster in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+ region: string, [Required] The Dataproc region in which to handle the request. (required)
+ clusterName: string, [Required] The cluster name. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
+ "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ "statusHistory": [ # [Output-only] Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
+ "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
+ "configuration": { # The cluster configuration. # [Required] The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
+ "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
+ "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified it will default to latest version.
+ "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
+ "a_key": "A String",
+ },
+ },
+ "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of worker node disk options.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "workers": [ # [Deprecated] The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
+ "A String",
+ ],
+ "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
+ },
+ },
+ "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine configuration settings for all instances in a cluster.
+ "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`.
+ "tags": [ # The Google Compute Engine tags to add to all instances.
+ "A String",
+ ],
+ "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
+ "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`.
+ "serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
+ "A String",
+ ],
+ "metadata": { # The Google Compute Engine metadata entries to add to all instances.
+ "a_key": "A String",
+ },
+ },
+ "masterName": "A String", # [Deprecated] The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
+ "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
+ "gceConfiguration": { # [Deprecated] Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Deprecated] The Google Compute Engine configuration settings for cluster resources.
+ "machineTypeUri": "A String", # [Deprecated] The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "networkUri": "A String", # [Deprecated] The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default".
+ "zoneUri": "A String", # [Deprecated] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
+ "serviceAccountScopes": [ # [Deprecated] The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
+ "A String",
+ ],
+ "imageUri": "A String", # [Deprecated] The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ },
+ "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
+ },
+ },
+ "numWorkers": 42, # [Deprecated] The number of worker nodes in the cluster.
+ "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
+ { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
+ "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
+ "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
+ },
+ ],
+ "masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of master node disk options.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
+ },
+ },
+ },
+ "createTime": "A String", # [Output-only] The timestamp of cluster creation.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(projectId, region, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Request a list of all regions/{region}/clusters in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+ region: string, [Required] The Dataproc region in which to handle the request. (required)
+ pageSize: integer, The standard List page size.
+ pageToken: string, The standard List page token.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The list of all clusters in a project.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "clusters": [ # [Output-only] The clusters in the project.
+ { # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
+ "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ "statusHistory": [ # [Output-only] Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
+ "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
+ "configuration": { # The cluster configuration. # [Required] The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
+ "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
+ "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified it will default to latest version.
+ "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
+ "a_key": "A String",
+ },
+ },
+ "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of worker node disk options.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "workers": [ # [Deprecated] The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
+ "A String",
+ ],
+ "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
+ },
+ },
+ "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine configuration settings for all instances in a cluster.
+ "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`.
+ "tags": [ # The Google Compute Engine tags to add to all instances.
+ "A String",
+ ],
+ "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
+ "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`.
+ "serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
+ "A String",
+ ],
+ "metadata": { # The Google Compute Engine metadata entries to add to all instances.
+ "a_key": "A String",
+ },
+ },
+ "masterName": "A String", # [Deprecated] The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
+ "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
+ "gceConfiguration": { # [Deprecated] Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Deprecated] The Google Compute Engine configuration settings for cluster resources.
+ "machineTypeUri": "A String", # [Deprecated] The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "networkUri": "A String", # [Deprecated] The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default".
+ "zoneUri": "A String", # [Deprecated] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
+ "serviceAccountScopes": [ # [Deprecated] The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
+ "A String",
+ ],
+ "imageUri": "A String", # [Deprecated] The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ },
+ "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
+ },
+ },
+ "numWorkers": 42, # [Deprecated] The number of worker nodes in the cluster.
+ "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
+ { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
+ "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
+ "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
+ },
+ ],
+ "masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of master node disk options.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
+ },
+ },
+ },
+ "createTime": "A String", # [Output-only] The timestamp of cluster creation.
+ },
+ ],
+ }</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(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)</code>
+ <pre>Request to update a cluster in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project the cluster belongs to. (required)
+ region: string, [Required] The Dataproc region in which to handle the request. (required)
+ clusterName: string, [Required] The cluster name. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
+ "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ "statusHistory": [ # [Output-only] Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
+ "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
+ "configuration": { # The cluster configuration. # [Required] The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
+ "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
+ "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified it will default to latest version.
+ "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
+ "a_key": "A String",
+ },
+ },
+ "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of worker node disk options.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "workers": [ # [Deprecated] The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
+ "A String",
+ ],
+ "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
+ },
+ },
+ "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine configuration settings for all instances in a cluster.
+ "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`.
+ "tags": [ # The Google Compute Engine tags to add to all instances.
+ "A String",
+ ],
+ "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
+ "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`.
+ "serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
+ "A String",
+ ],
+ "metadata": { # The Google Compute Engine metadata entries to add to all instances.
+ "a_key": "A String",
+ },
+ },
+ "masterName": "A String", # [Deprecated] The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
+ "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
+ "gceConfiguration": { # [Deprecated] Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Deprecated] The Google Compute Engine configuration settings for cluster resources.
+ "machineTypeUri": "A String", # [Deprecated] The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "networkUri": "A String", # [Deprecated] The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default".
+ "zoneUri": "A String", # [Deprecated] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
+ "serviceAccountScopes": [ # [Deprecated] The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
+ "A String",
+ ],
+ "imageUri": "A String", # [Deprecated] The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ },
+ "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
+ },
+ },
+ "numWorkers": 42, # [Deprecated] The number of worker nodes in the cluster.
+ "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
+ { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
+ "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
+ "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
+ },
+ ],
+ "masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of master node disk options.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
+ },
+ },
+ },
+ "createTime": "A String", # [Output-only] The timestamp of cluster creation.
+ }
+
+ updateMask: string, [Required] Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as "configuration.worker_configuration.num_instances," and the PATCH request body would specify the new value, as follows: { "configuration":{ "workerConfiguration":{ "numInstances":"5" } } } Note: Currently, configuration.worker_configuration.num_instances is the only field that can be updated.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
+ "response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ ],
+ },
+ "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
+ "name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
+ "metadata": { # Service-specific metadata associated with the operation.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/container_v1beta1.projects.zones.html b/docs/dyn/dataproc_v1alpha1.projects.regions.html
similarity index 71%
rename from docs/dyn/container_v1beta1.projects.zones.html
rename to docs/dyn/dataproc_v1alpha1.projects.regions.html
index 7393494..e47c3cf 100644
--- a/docs/dyn/container_v1beta1.projects.zones.html
+++ b/docs/dyn/dataproc_v1alpha1.projects.regions.html
@@ -72,16 +72,16 @@
</style>
-<h1><a href="container_v1beta1.html">Google Container Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.zones.html">zones</a></h1>
+<h1><a href="dataproc_v1alpha1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1alpha1.projects.html">projects</a> . <a href="dataproc_v1alpha1.projects.regions.html">regions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="container_v1beta1.projects.zones.clusters.html">clusters()</a></code>
+ <code><a href="dataproc_v1alpha1.projects.regions.clusters.html">clusters()</a></code>
</p>
<p class="firstline">Returns the clusters Resource.</p>
<p class="toc_element">
- <code><a href="container_v1beta1.projects.zones.operations.html">operations()</a></code>
+ <code><a href="dataproc_v1alpha1.projects.regions.jobs.html">jobs()</a></code>
</p>
-<p class="firstline">Returns the operations Resource.</p>
+<p class="firstline">Returns the jobs Resource.</p>
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dataproc_v1alpha1.projects.regions.jobs.html b/docs/dyn/dataproc_v1alpha1.projects.regions.jobs.html
new file mode 100644
index 0000000..0983099
--- /dev/null
+++ b/docs/dyn/dataproc_v1alpha1.projects.regions.jobs.html
@@ -0,0 +1,1056 @@
+<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="dataproc_v1alpha1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1alpha1.projects.html">projects</a> . <a href="dataproc_v1alpha1.projects.regions.html">regions</a> . <a href="dataproc_v1alpha1.projects.regions.jobs.html">jobs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#cancel">cancel(projectId, region, jobId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs:list or regions/{region}/jobs:get.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(projectId, region, jobId, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.</p>
+<p class="toc_element">
+ <code><a href="#get">get(projectId, region, jobId, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the resource representation for a job in a project.</p>
+<p class="toc_element">
+ <code><a href="#submit">submit(projectId, region, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Submits a job to a cluster.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="cancel">cancel(projectId, region, jobId, body, x__xgafv=None)</code>
+ <pre>Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs:list or regions/{region}/jobs:get.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+ region: string, [Required] The Dataproc region in which to handle the request. (required)
+ jobId: string, [Required] The job ID. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A request to cancel a job.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A Cloud Dataproc job resource.
+ "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "insertTime": "A String", # The time of the job request.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ "startTime": "A String", # The time when the server started the job.
+ "endTime": "A String", # The time when the job completed.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # [Output-only] The previous job status.
+ { # Cloud Dataproc job status.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "insertTime": "A String", # The time of the job request.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ "startTime": "A String", # The time when the server started the job.
+ "endTime": "A String", # The time when the job completed.
+ },
+ ],
+ "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+ "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 512 characters.
+ },
+ "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputUri": "A String", # [Output-only] A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, gs://sysbucket123/foo-cluster/jobid-123/driver/output.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: "name=[value]").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+ "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
+ "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
+ "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
+ "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "yarnApplications": [ # [Output-only] The collection of Yarn applications spun up by this job.
+ { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
+ "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
+ "state": "A String", # [Required] The application state.
+ "name": "A String", # [Required] The application name.
+ "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
+ },
+ ],
+ "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+ "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+ "A String",
+ ],
+ "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
+ "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "interactive": True or False, # [Optional] If set to true, then the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(projectId, region, jobId, x__xgafv=None)</code>
+ <pre>Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+ region: string, [Required] The Dataproc region in which to handle the request. (required)
+ jobId: string, [Required] The job ID. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A Cloud Dataproc job resource.
+ "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "insertTime": "A String", # The time of the job request.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ "startTime": "A String", # The time when the server started the job.
+ "endTime": "A String", # The time when the job completed.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # [Output-only] The previous job status.
+ { # Cloud Dataproc job status.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "insertTime": "A String", # The time of the job request.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ "startTime": "A String", # The time when the server started the job.
+ "endTime": "A String", # The time when the job completed.
+ },
+ ],
+ "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+ "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 512 characters.
+ },
+ "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputUri": "A String", # [Output-only] A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, gs://sysbucket123/foo-cluster/jobid-123/driver/output.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: "name=[value]").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+ "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
+ "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
+ "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
+ "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "yarnApplications": [ # [Output-only] The collection of Yarn applications spun up by this job.
+ { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
+ "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
+ "state": "A String", # [Required] The application state.
+ "name": "A String", # [Required] The application name.
+ "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
+ },
+ ],
+ "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+ "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+ "A String",
+ ],
+ "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
+ "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "interactive": True or False, # [Optional] If set to true, then the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(projectId, region, jobId, x__xgafv=None)</code>
+ <pre>Gets the resource representation for a job in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+ region: string, [Required] The Dataproc region in which to handle the request. (required)
+ jobId: string, [Required] The job ID. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A Cloud Dataproc job resource.
+ "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "insertTime": "A String", # The time of the job request.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ "startTime": "A String", # The time when the server started the job.
+ "endTime": "A String", # The time when the job completed.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # [Output-only] The previous job status.
+ { # Cloud Dataproc job status.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "insertTime": "A String", # The time of the job request.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ "startTime": "A String", # The time when the server started the job.
+ "endTime": "A String", # The time when the job completed.
+ },
+ ],
+ "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+ "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 512 characters.
+ },
+ "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputUri": "A String", # [Output-only] A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, gs://sysbucket123/foo-cluster/jobid-123/driver/output.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: "name=[value]").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+ "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
+ "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
+ "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
+ "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "yarnApplications": [ # [Output-only] The collection of Yarn applications spun up by this job.
+ { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
+ "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
+ "state": "A String", # [Required] The application state.
+ "name": "A String", # [Required] The application name.
+ "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
+ },
+ ],
+ "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+ "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+ "A String",
+ ],
+ "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
+ "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "interactive": True or False, # [Optional] If set to true, then the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="submit">submit(projectId, region, body, x__xgafv=None)</code>
+ <pre>Submits a job to a cluster.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+ region: string, [Required] The Dataproc region in which to handle the request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A job submission request.
+ "job": { # A Cloud Dataproc job resource. # [Required] The job resource.
+ "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "insertTime": "A String", # The time of the job request.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ "startTime": "A String", # The time when the server started the job.
+ "endTime": "A String", # The time when the job completed.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # [Output-only] The previous job status.
+ { # Cloud Dataproc job status.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "insertTime": "A String", # The time of the job request.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ "startTime": "A String", # The time when the server started the job.
+ "endTime": "A String", # The time when the job completed.
+ },
+ ],
+ "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+ "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 512 characters.
+ },
+ "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputUri": "A String", # [Output-only] A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, gs://sysbucket123/foo-cluster/jobid-123/driver/output.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: "name=[value]").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+ "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
+ "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
+ "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
+ "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "yarnApplications": [ # [Output-only] The collection of Yarn applications spun up by this job.
+ { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
+ "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
+ "state": "A String", # [Required] The application state.
+ "name": "A String", # [Required] The application name.
+ "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
+ },
+ ],
+ "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+ "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+ "A String",
+ ],
+ "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
+ "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "interactive": True or False, # [Optional] If set to true, then the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A Cloud Dataproc job resource.
+ "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "insertTime": "A String", # The time of the job request.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ "startTime": "A String", # The time when the server started the job.
+ "endTime": "A String", # The time when the job completed.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # [Output-only] The previous job status.
+ { # Cloud Dataproc job status.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "insertTime": "A String", # The time of the job request.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ "startTime": "A String", # The time when the server started the job.
+ "endTime": "A String", # The time when the job completed.
+ },
+ ],
+ "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+ "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 512 characters.
+ },
+ "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputUri": "A String", # [Output-only] A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, gs://sysbucket123/foo-cluster/jobid-123/driver/output.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: "name=[value]").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+ "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
+ "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
+ "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
+ "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "yarnApplications": [ # [Output-only] The collection of Yarn applications spun up by this job.
+ { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
+ "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
+ "state": "A String", # [Required] The application state.
+ "name": "A String", # [Required] The application name.
+ "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
+ },
+ ],
+ "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+ "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+ "A String",
+ ],
+ "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
+ "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "interactive": True or False, # [Optional] If set to true, then the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.html b/docs/dyn/dataproc_v1beta1.html
similarity index 86%
copy from docs/dyn/serviceregistry_alpha.html
copy to docs/dyn/dataproc_v1beta1.html
index fe160ea..83184e7 100644
--- a/docs/dyn/serviceregistry_alpha.html
+++ b/docs/dyn/dataproc_v1beta1.html
@@ -72,19 +72,19 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a></h1>
+<h1><a href="dataproc_v1beta1.html">Google Cloud Dataproc API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="serviceregistry_alpha.endpoints.html">endpoints()</a></code>
-</p>
-<p class="firstline">Returns the endpoints Resource.</p>
-
-<p class="toc_element">
- <code><a href="serviceregistry_alpha.operations.html">operations()</a></code>
+ <code><a href="dataproc_v1beta1.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
+ <code><a href="dataproc_v1beta1.projects.html">projects()</a></code>
+</p>
+<p class="firstline">Returns the projects Resource.</p>
+
+<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
<h3>Method Details</h3>
diff --git a/docs/dyn/dataproc_v1beta1.operations.html b/docs/dyn/dataproc_v1beta1.operations.html
new file mode 100644
index 0000000..edf2fa3
--- /dev/null
+++ b/docs/dyn/dataproc_v1beta1.operations.html
@@ -0,0 +1,215 @@
+<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="dataproc_v1beta1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1beta1.operations.html">operations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#cancel">cancel(name, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use [operations.get](/dataproc/reference/rest/v1beta1/operations/get) or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.</p>
+<p class="toc_element">
+ <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.</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="cancel">cancel(name, body, x__xgafv=None)</code>
+ <pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use [operations.get](/dataproc/reference/rest/v1beta1/operations/get) or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.
+
+Args:
+ name: string, The name of the operation collection. (required)
+ pageSize: integer, The standard list page size.
+ filter: string, The standard list filter.
+ pageToken: string, The standard list page token.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ },
+ ],
+ "nextPageToken": "A String", # The standard List next-page token.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/dataproc_v1beta1.projects.clusters.html b/docs/dyn/dataproc_v1beta1.projects.clusters.html
new file mode 100644
index 0000000..b478300
--- /dev/null
+++ b/docs/dyn/dataproc_v1beta1.projects.clusters.html
@@ -0,0 +1,681 @@
+<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="dataproc_v1beta1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1beta1.projects.html">projects</a> . <a href="dataproc_v1beta1.projects.clusters.html">clusters</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(projectId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a cluster in a project.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(projectId, clusterName, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a cluster in a project.</p>
+<p class="toc_element">
+ <code><a href="#diagnose">diagnose(projectId, clusterName, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.</p>
+<p class="toc_element">
+ <code><a href="#get">get(projectId, clusterName, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the resource representation for a cluster in a project.</p>
+<p class="toc_element">
+ <code><a href="#list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists all clusters in a 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(projectId, clusterName, body, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates a cluster in a project.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(projectId, body, x__xgafv=None)</code>
+ <pre>Creates a cluster in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
+ "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ "statusHistory": [ # [Output-only] Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
+ "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
+ "configuration": { # The cluster configuration. # [Required] The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
+ "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
+ "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
+ "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
+ "a_key": "A String",
+ },
+ },
+ "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine configuration settings for all instances in a cluster.
+ "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
+ "tags": [ # The Google Compute Engine tags to add to all instances.
+ "A String",
+ ],
+ "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
+ "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
+ "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control
+ "A String",
+ ],
+ "metadata": { # The Google Compute Engine metadata entries to add to all instances.
+ "a_key": "A String",
+ },
+ },
+ "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
+ "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+ },
+ },
+ "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
+ { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
+ "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
+ "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
+ },
+ ],
+ "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+ },
+ },
+ "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+ },
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(projectId, clusterName, x__xgafv=None)</code>
+ <pre>Deletes a cluster in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+ clusterName: string, [Required] The cluster name. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="diagnose">diagnose(projectId, clusterName, body, x__xgafv=None)</code>
+ <pre>Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+ clusterName: string, [Required] The cluster name. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A request to collect cluster diagnostic information.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(projectId, clusterName, x__xgafv=None)</code>
+ <pre>Gets the resource representation for a cluster in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+ clusterName: string, [Required] The cluster name. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
+ "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ "statusHistory": [ # [Output-only] Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
+ "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
+ "configuration": { # The cluster configuration. # [Required] The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
+ "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
+ "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
+ "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
+ "a_key": "A String",
+ },
+ },
+ "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine configuration settings for all instances in a cluster.
+ "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
+ "tags": [ # The Google Compute Engine tags to add to all instances.
+ "A String",
+ ],
+ "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
+ "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
+ "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control
+ "A String",
+ ],
+ "metadata": { # The Google Compute Engine metadata entries to add to all instances.
+ "a_key": "A String",
+ },
+ },
+ "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
+ "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+ },
+ },
+ "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
+ { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
+ "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
+ "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
+ },
+ ],
+ "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+ },
+ },
+ "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+ },
+ },
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists all clusters in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+ pageSize: integer, The standard List page size.
+ pageToken: string, The standard List page token.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The list of all clusters in a project.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "clusters": [ # [Output-only] The clusters in the project.
+ { # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
+ "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ "statusHistory": [ # [Output-only] Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
+ "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
+ "configuration": { # The cluster configuration. # [Required] The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
+ "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
+ "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
+ "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
+ "a_key": "A String",
+ },
+ },
+ "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine configuration settings for all instances in a cluster.
+ "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
+ "tags": [ # The Google Compute Engine tags to add to all instances.
+ "A String",
+ ],
+ "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
+ "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
+ "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control
+ "A String",
+ ],
+ "metadata": { # The Google Compute Engine metadata entries to add to all instances.
+ "a_key": "A String",
+ },
+ },
+ "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
+ "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+ },
+ },
+ "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
+ { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
+ "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
+ "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
+ },
+ ],
+ "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+ },
+ },
+ "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+ },
+ },
+ },
+ },
+ ],
+ }</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(projectId, clusterName, body, updateMask=None, x__xgafv=None)</code>
+ <pre>Updates a cluster in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project the cluster belongs to. (required)
+ clusterName: string, [Required] The cluster name. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
+ "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ "statusHistory": [ # [Output-only] Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
+ "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
+ "configuration": { # The cluster configuration. # [Required] The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
+ "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
+ "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
+ "properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
+ "a_key": "A String",
+ },
+ },
+ "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine configuration settings for all instances in a cluster.
+ "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
+ "tags": [ # The Google Compute Engine tags to add to all instances.
+ "A String",
+ ],
+ "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
+ "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
+ "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control
+ "A String",
+ ],
+ "metadata": { # The Google Compute Engine metadata entries to add to all instances.
+ "a_key": "A String",
+ },
+ },
+ "configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
+ "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+ },
+ },
+ "initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
+ { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
+ "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
+ "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
+ },
+ ],
+ "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+ },
+ },
+ "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
+ "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+ "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+ "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+ "A String",
+ ],
+ "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfiguration.image_version`.
+ "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+ "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
+ "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+ },
+ "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+ "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+ },
+ },
+ },
+}
+
+ updateMask: string, [Required] Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as configuration.worker_configuration.num_instances, and the `PATCH` request body would specify the new value, as follows: { "configuration":{ "workerConfiguration":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the `PATCH` request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, config.worker_config.num_instances and config.secondary_worker_config.num_instances are the only fields that can be updated.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dataflow_v1beta3.v1b3.projects.html b/docs/dyn/dataproc_v1beta1.projects.html
similarity index 74%
rename from docs/dyn/dataflow_v1beta3.v1b3.projects.html
rename to docs/dyn/dataproc_v1beta1.projects.html
index 8f220f1..bb7b34e 100644
--- a/docs/dyn/dataflow_v1beta3.v1b3.projects.html
+++ b/docs/dyn/dataproc_v1beta1.projects.html
@@ -72,10 +72,15 @@
</style>
-<h1><a href="dataflow_v1beta3.html">Google Dataflow API</a> . <a href="dataflow_v1beta3.v1b3.html">v1b3</a> . <a href="dataflow_v1beta3.v1b3.projects.html">projects</a></h1>
+<h1><a href="dataproc_v1beta1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1beta1.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="dataflow_v1beta3.v1b3.projects.jobs.html">jobs()</a></code>
+ <code><a href="dataproc_v1beta1.projects.clusters.html">clusters()</a></code>
+</p>
+<p class="firstline">Returns the clusters Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dataproc_v1beta1.projects.jobs.html">jobs()</a></code>
</p>
<p class="firstline">Returns the jobs Resource.</p>
diff --git a/docs/dyn/dataproc_v1beta1.projects.jobs.html b/docs/dyn/dataproc_v1beta1.projects.jobs.html
new file mode 100644
index 0000000..6dfcc9c
--- /dev/null
+++ b/docs/dyn/dataproc_v1beta1.projects.jobs.html
@@ -0,0 +1,1061 @@
+<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="dataproc_v1beta1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1beta1.projects.html">projects</a> . <a href="dataproc_v1beta1.projects.jobs.html">jobs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#cancel">cancel(projectId, jobId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Starts a job cancellation request. To access the job resource after cancellation, call [jobs.list](/dataproc/reference/rest/v1beta1/projects.jobs/list) or [jobs.get](/dataproc/reference/rest/v1beta1/projects.jobs/get).</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(projectId, jobId, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.</p>
+<p class="toc_element">
+ <code><a href="#get">get(projectId, jobId, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the resource representation for a job in a project.</p>
+<p class="toc_element">
+ <code><a href="#list">list(projectId, jobStateMatcher=None, pageSize=None, clusterName=None, x__xgafv=None, pageToken=None)</a></code></p>
+<p class="firstline">Lists jobs in a 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="#submit">submit(projectId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Submits a job to a cluster.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="cancel">cancel(projectId, jobId, body, x__xgafv=None)</code>
+ <pre>Starts a job cancellation request. To access the job resource after cancellation, call [jobs.list](/dataproc/reference/rest/v1beta1/projects.jobs/list) or [jobs.get](/dataproc/reference/rest/v1beta1/projects.jobs/get).
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+ jobId: string, [Required] The job ID. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A request to cancel a job.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A Cloud Dataproc job resource.
+ "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+ "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # [Output-only] The previous job status.
+ { # Cloud Dataproc job status.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ },
+ ],
+ "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+ "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
+ },
+ "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+ "a_key": "A String",
+ },
+ },
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+ "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
+ "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
+ "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
+ "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "yarnApplications": [ # [Output-only] The collection of YARN applications spun up by this job.
+ { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
+ "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
+ "state": "A String", # [Required] The application state.
+ "name": "A String", # [Required] The application name.
+ "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
+ },
+ ],
+ "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+ "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+ "A String",
+ ],
+ "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+ "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "interactive": True or False, # [Optional] If set to `true`, the driver's stdin will be kept open and `driver_input_uri` will be set to provide a path at which additional input can be sent to the driver.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(projectId, jobId, x__xgafv=None)</code>
+ <pre>Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+ jobId: string, [Required] The job ID. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(projectId, jobId, x__xgafv=None)</code>
+ <pre>Gets the resource representation for a job in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+ jobId: string, [Required] The job ID. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A Cloud Dataproc job resource.
+ "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+ "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # [Output-only] The previous job status.
+ { # Cloud Dataproc job status.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ },
+ ],
+ "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+ "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
+ },
+ "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+ "a_key": "A String",
+ },
+ },
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+ "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
+ "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
+ "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
+ "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "yarnApplications": [ # [Output-only] The collection of YARN applications spun up by this job.
+ { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
+ "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
+ "state": "A String", # [Required] The application state.
+ "name": "A String", # [Required] The application name.
+ "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
+ },
+ ],
+ "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+ "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+ "A String",
+ ],
+ "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+ "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "interactive": True or False, # [Optional] If set to `true`, the driver's stdin will be kept open and `driver_input_uri` will be set to provide a path at which additional input can be sent to the driver.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(projectId, jobStateMatcher=None, pageSize=None, clusterName=None, x__xgafv=None, pageToken=None)</code>
+ <pre>Lists jobs in a project.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+ jobStateMatcher: string, [Optional] Specifies enumerated categories of jobs to list.
+ pageSize: integer, [Optional] The number of results to return in each response.
+ clusterName: string, [Optional] If set, the returned jobs list includes only jobs that were submitted to the named cluster.
+ x__xgafv: string, V1 error format.
+ pageToken: string, [Optional] The page token, returned by a previous call, to request the next page of results.
+
+Returns:
+ An object of the form:
+
+ { # A list of jobs in a project.
+ "nextPageToken": "A String", # [Optional] This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the `page_token` in a subsequent ListJobsRequest.
+ "jobs": [ # [Output-only] Jobs list.
+ { # A Cloud Dataproc job resource.
+ "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+ "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # [Output-only] The previous job status.
+ { # Cloud Dataproc job status.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ },
+ ],
+ "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+ "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
+ },
+ "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+ "a_key": "A String",
+ },
+ },
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+ "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
+ "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
+ "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
+ "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "yarnApplications": [ # [Output-only] The collection of YARN applications spun up by this job.
+ { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
+ "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
+ "state": "A String", # [Required] The application state.
+ "name": "A String", # [Required] The application name.
+ "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
+ },
+ ],
+ "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+ "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+ "A String",
+ ],
+ "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+ "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "interactive": True or False, # [Optional] If set to `true`, the driver's stdin will be kept open and `driver_input_uri` will be set to provide a path at which additional input can be sent to the driver.
+ },
+ ],
+ }</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="submit">submit(projectId, body, x__xgafv=None)</code>
+ <pre>Submits a job to a cluster.
+
+Args:
+ projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A request to submit a job.
+ "job": { # A Cloud Dataproc job resource. # [Required] The job resource.
+ "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+ "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # [Output-only] The previous job status.
+ { # Cloud Dataproc job status.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ },
+ ],
+ "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+ "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
+ },
+ "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+ "a_key": "A String",
+ },
+ },
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+ "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
+ "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
+ "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
+ "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "yarnApplications": [ # [Output-only] The collection of YARN applications spun up by this job.
+ { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
+ "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
+ "state": "A String", # [Required] The application state.
+ "name": "A String", # [Required] The application name.
+ "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
+ },
+ ],
+ "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+ "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+ "A String",
+ ],
+ "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+ "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "interactive": True or False, # [Optional] If set to `true`, the driver's stdin will be kept open and `driver_input_uri` will be set to provide a path at which additional input can be sent to the driver.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A Cloud Dataproc job resource.
+ "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+ "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "statusHistory": [ # [Output-only] The previous job status.
+ { # Cloud Dataproc job status.
+ "state": "A String", # [Required] A state message specifying the overall job state.
+ "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+ "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+ },
+ ],
+ "placement": { # Cloud Dataproc job configuration. # [Required] Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+ "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
+ },
+ "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+ "a_key": "A String",
+ },
+ },
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+ "submittedBy": "A String", # [Output-only] The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname.
+ "driverInputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
+ "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
+ "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "A String",
+ ],
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+ "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "yarnApplications": [ # [Output-only] The collection of YARN applications spun up by this job.
+ { # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
+ "progress": 3.14, # [Required] The numerical progress of the application, from 1 to 100.
+ "state": "A String", # [Required] The application state.
+ "name": "A String", # [Required] The application name.
+ "trackingUrl": "A String", # [Optional] The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
+ },
+ ],
+ "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+ "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+ "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # [Optional] The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+ "A String",
+ ],
+ "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+ "A String",
+ ],
+ "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+ "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+ "A String",
+ ],
+ "queryList": { # A list of queries to run on a cluster. # A list of queries.
+ "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+ "A String",
+ ],
+ },
+ "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+ "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "interactive": True or False, # [Optional] If set to `true`, the driver's stdin will be kept open and `driver_input_uri` will be set to provide a path at which additional input can be sent to the driver.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/datastore_v1beta1.datasets.html b/docs/dyn/datastore_v1beta1.datasets.html
new file mode 100644
index 0000000..26cc213
--- /dev/null
+++ b/docs/dyn/datastore_v1beta1.datasets.html
@@ -0,0 +1,1281 @@
+<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> . <a href="datastore_v1beta1.datasets.html">datasets</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#allocateIds">allocateIds(datasetId, body)</a></code></p>
+<p class="firstline">Allocate IDs for incomplete keys (useful for referencing an entity before it is inserted).</p>
+<p class="toc_element">
+ <code><a href="#beginTransaction">beginTransaction(datasetId, body)</a></code></p>
+<p class="firstline">Begin a new transaction.</p>
+<p class="toc_element">
+ <code><a href="#blindWrite">blindWrite(datasetId, body)</a></code></p>
+<p class="firstline">Create, delete or modify some entities outside a transaction.</p>
+<p class="toc_element">
+ <code><a href="#commit">commit(datasetId, body)</a></code></p>
+<p class="firstline">Commit a transaction, optionally creating, deleting or modifying some entities.</p>
+<p class="toc_element">
+ <code><a href="#lookup">lookup(datasetId, body)</a></code></p>
+<p class="firstline">Look up some entities by key.</p>
+<p class="toc_element">
+ <code><a href="#rollback">rollback(datasetId, body)</a></code></p>
+<p class="firstline">Roll back a transaction.</p>
+<p class="toc_element">
+ <code><a href="#runQuery">runQuery(datasetId, body)</a></code></p>
+<p class="firstline">Query for entities.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="allocateIds">allocateIds(datasetId, body)</code>
+ <pre>Allocate IDs for incomplete keys (useful for referencing an entity before it is inserted).
+
+Args:
+ datasetId: string, Identifies the dataset. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "keys": [ # A list of keys with incomplete key paths to allocate IDs for. No key may be reserved/read-only.
+ { # A unique identifier for an entity.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "keys": [ # The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.
+ { # A unique identifier for an entity.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ ],
+ "header": {
+ "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "datastore#responseHeader".
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="beginTransaction">beginTransaction(datasetId, body)</code>
+ <pre>Begin a new transaction.
+
+Args:
+ datasetId: string, Identifies the dataset. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "isolationLevel": "A String", # The transaction isolation level. Either snapshot or serializable. The default isolation level is snapshot isolation, which means that another transaction may not concurrently modify the data that is modified by this transaction. Optionally, a transaction can request to be made serializable which means that another transaction cannot concurrently modify the data that is read or modified by this transaction.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "header": {
+ "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "datastore#responseHeader".
+ },
+ "transaction": "A String", # The transaction identifier (always present).
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="blindWrite">blindWrite(datasetId, body)</code>
+ <pre>Create, delete or modify some entities outside a transaction.
+
+Args:
+ datasetId: string, Identifies the dataset. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "mutation": { # A set of changes to apply. # The mutation to perform.
+ "insert": [ # Entities to insert. Each inserted entity's key must have a complete path and must not be reserved/read-only.
+ { # An entity.
+ "properties": { # The entity's properties.
+ "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
+ "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
+ "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
+ { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ ],
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ },
+ ],
+ "force": True or False, # Ignore a user specified read-only period. Optional.
+ "insertAutoId": [ # Insert entities with a newly allocated ID. Each inserted entity's key must omit the final identifier in its path and must not be reserved/read-only.
+ { # An entity.
+ "properties": { # The entity's properties.
+ "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
+ "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
+ "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
+ { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ ],
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ },
+ ],
+ "update": [ # Entities to update. Each updated entity's key must have a complete path and must not be reserved/read-only.
+ { # An entity.
+ "properties": { # The entity's properties.
+ "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
+ "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
+ "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
+ { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ ],
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ },
+ ],
+ "delete": [ # Keys of entities to delete. Each key must have a complete key path and must not be reserved/read-only.
+ { # A unique identifier for an entity.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ ],
+ "upsert": [ # Entities to upsert. Each upserted entity's key must have a complete path and must not be reserved/read-only.
+ { # An entity.
+ "properties": { # The entity's properties.
+ "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
+ "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
+ "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
+ { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ ],
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ },
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "header": {
+ "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "datastore#responseHeader".
+ },
+ "mutationResult": { # The result of performing the mutation (always present).
+ "insertAutoIdKeys": [ # Keys for insertAutoId entities. One per entity from the request, in the same order.
+ { # A unique identifier for an entity.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ ],
+ "indexUpdates": 42, # Number of index writes.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="commit">commit(datasetId, body)</code>
+ <pre>Commit a transaction, optionally creating, deleting or modifying some entities.
+
+Args:
+ datasetId: string, Identifies the dataset. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "ignoreReadOnly": True or False,
+ "transaction": "A String", # The transaction identifier, returned by a call to beginTransaction. Must be set when mode is TRANSACTIONAL.
+ "mutation": { # A set of changes to apply. # The mutation to perform. Optional.
+ "insert": [ # Entities to insert. Each inserted entity's key must have a complete path and must not be reserved/read-only.
+ { # An entity.
+ "properties": { # The entity's properties.
+ "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
+ "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
+ "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
+ { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ ],
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ },
+ ],
+ "force": True or False, # Ignore a user specified read-only period. Optional.
+ "insertAutoId": [ # Insert entities with a newly allocated ID. Each inserted entity's key must omit the final identifier in its path and must not be reserved/read-only.
+ { # An entity.
+ "properties": { # The entity's properties.
+ "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
+ "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
+ "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
+ { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ ],
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ },
+ ],
+ "update": [ # Entities to update. Each updated entity's key must have a complete path and must not be reserved/read-only.
+ { # An entity.
+ "properties": { # The entity's properties.
+ "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
+ "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
+ "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
+ { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ ],
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ },
+ ],
+ "delete": [ # Keys of entities to delete. Each key must have a complete key path and must not be reserved/read-only.
+ { # A unique identifier for an entity.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ ],
+ "upsert": [ # Entities to upsert. Each upserted entity's key must have a complete path and must not be reserved/read-only.
+ { # An entity.
+ "properties": { # The entity's properties.
+ "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
+ "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
+ "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
+ { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ ],
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ },
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "header": {
+ "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "datastore#responseHeader".
+ },
+ "mutationResult": { # The result of performing the mutation (if any).
+ "insertAutoIdKeys": [ # Keys for insertAutoId entities. One per entity from the request, in the same order.
+ { # A unique identifier for an entity.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ ],
+ "indexUpdates": 42, # Number of index writes.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="lookup">lookup(datasetId, body)</code>
+ <pre>Look up some entities by key.
+
+Args:
+ datasetId: string, Identifies the dataset. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "keys": [ # Keys of entities to look up from the datastore.
+ { # A unique identifier for an entity.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ ],
+ "readOptions": { # Options for this lookup request. Optional.
+ "transaction": "A String", # The transaction to use. Optional.
+ "readConsistency": "A String", # The read consistency to use. One of default, strong, or eventual. Cannot be set when transaction is set. Lookup and ancestor queries default to strong, global queries default to eventual and cannot be set to strong. Optional. Default is default.
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "deferred": [ # A list of keys that were not looked up due to resource constraints.
+ { # A unique identifier for an entity.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ ],
+ "missing": [ # Entities not found, with only the key populated.
+ { # The result of fetching an entity from the datastore.
+ "entity": { # An entity. # The resulting entity.
+ "properties": { # The entity's properties.
+ "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
+ "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
+ "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
+ { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ ],
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ },
+ },
+ ],
+ "header": {
+ "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "datastore#responseHeader".
+ },
+ "found": [ # Entities found.
+ { # The result of fetching an entity from the datastore.
+ "entity": { # An entity. # The resulting entity.
+ "properties": { # The entity's properties.
+ "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
+ "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
+ "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
+ { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ ],
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ },
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="rollback">rollback(datasetId, body)</code>
+ <pre>Roll back a transaction.
+
+Args:
+ datasetId: string, Identifies the dataset. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "transaction": "A String", # The transaction identifier, returned by a call to beginTransaction.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "header": {
+ "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "datastore#responseHeader".
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="runQuery">runQuery(datasetId, body)</code>
+ <pre>Query for entities.
+
+Args:
+ datasetId: string, Identifies the dataset. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "query": { # A query. # The query to run. Either this field or field gql_query must be set, but not both.
+ "startCursor": "A String", # A starting point for the query results. Optional. Query cursors are returned in query result batches.
+ "kinds": [ # The kinds to query (if empty, returns entities from all kinds).
+ { # A representation of a kind.
+ "name": "A String", # The name of the kind.
+ },
+ ],
+ "projection": [ # The projection to return. If not set the entire entity is returned.
+ { # A representation of a property in a projection.
+ "aggregationFunction": "A String", # The aggregation function to apply to the property. Optional. Can only be used when grouping by at least one property. Must then be set on all properties in the projection that are not being grouped by. Aggregation functions: first selects the first result as determined by the query's order.
+ "property": { # A reference to a property relative to the kind expressions. # The property to project.
+ "name": "A String", # The name of the property.
+ },
+ },
+ ],
+ "order": [ # The order to apply to the query results (if empty, order is unspecified).
+ { # The desired order for a specific property.
+ "direction": "A String", # The direction to order by. One of ascending or descending. Optional, defaults to ascending.
+ "property": { # A reference to a property relative to the kind expressions. # The property to order by.
+ "name": "A String", # The name of the property.
+ },
+ },
+ ],
+ "filter": { # A holder for any type of filter. Exactly one field should be specified. # The filter to apply (optional).
+ "compositeFilter": { # A filter that merges the multiple other filters using the given operation. # A composite filter.
+ "operator": "A String", # The operator for combining multiple filters. Only "and" is currently supported.
+ "filters": [ # The list of filters to combine. Must contain at least one filter.
+ # Object with schema name: Filter
+ ],
+ },
+ "propertyFilter": { # A filter on a specific property. # A filter on a property.
+ "operator": "A String", # The operator to filter by. One of lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, equal, or hasAncestor.
+ "property": { # A reference to a property relative to the kind expressions. # The property to filter by.
+ "name": "A String", # The name of the property.
+ },
+ "value": { # A message that can hold any of the supported value types and associated metadata. # The value to compare the property to.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ },
+ },
+ "limit": 42, # The maximum number of results to return. Applies after all other constraints. Optional.
+ "offset": 42, # The number of results to skip. Applies before limit, but after all other constraints (optional, defaults to 0).
+ "endCursor": "A String", # An ending point for the query results. Optional. Query cursors are returned in query result batches.
+ "groupBy": [ # The properties to group by (if empty, no grouping is applied to the result set).
+ { # A reference to a property relative to the kind expressions.
+ "name": "A String", # The name of the property.
+ },
+ ],
+ },
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID, but all other partition IDs in RunQueryRequest are normalized with this partition ID as the context partition ID.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ "gqlQuery": { # A GQL query. # The GQL query to run. Either this field or field query must be set, but not both.
+ "queryString": "A String", # The query string.
+ "nameArgs": [ # A named argument must set field GqlQueryArg.name. No two named arguments may have the same name. For each non-reserved named binding site in the query string, there must be a named argument with that name, but not necessarily the inverse.
+ { # A binding argument for a GQL query.
+ "cursor": "A String",
+ "name": "A String", # Must match regex "[A-Za-z_$][A-Za-z_$0-9]*". Must not match regex "__.*__". Must not be "".
+ "value": { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ },
+ ],
+ "allowLiteral": True or False, # When false, the query string must not contain a literal.
+ "numberArgs": [ # Numbered binding site @1 references the first numbered argument, effectively using 1-based indexing, rather than the usual 0. A numbered argument must NOT set field GqlQueryArg.name. For each binding site numbered i in query_string, there must be an ith numbered argument. The inverse must also be true.
+ { # A binding argument for a GQL query.
+ "cursor": "A String",
+ "name": "A String", # Must match regex "[A-Za-z_$][A-Za-z_$0-9]*". Must not match regex "__.*__". Must not be "".
+ "value": { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ },
+ ],
+ },
+ "readOptions": { # The options for this query.
+ "transaction": "A String", # The transaction to use. Optional.
+ "readConsistency": "A String", # The read consistency to use. One of default, strong, or eventual. Cannot be set when transaction is set. Lookup and ancestor queries default to strong, global queries default to eventual and cannot be set to strong. Optional. Default is default.
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "header": {
+ "kind": "datastore#responseHeader", # Identifies what kind of resource this is. Value: the fixed string "datastore#responseHeader".
+ },
+ "batch": { # A batch of results produced by a query. # A batch of query results (always present).
+ "moreResults": "A String", # The state of the query after the current batch. One of notFinished, moreResultsAfterLimit, noMoreResults.
+ "entityResults": [ # The results for this batch.
+ { # The result of fetching an entity from the datastore.
+ "entity": { # An entity. # The resulting entity.
+ "properties": { # The entity's properties.
+ "a_key": { # An entity property. # The name of the property. A property name matching regex "__.*__" is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. Cannot be "".
+ "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
+ "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
+ { # A message that can hold any of the supported value types and associated metadata.
+ "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
+ "doubleValue": 3.14, # A double value.
+ "integerValue": "A String", # An integer value.
+ "meaning": 42, # The meaning field is reserved and should not be used.
+ "dateTimeValue": "A String", # A timestamp value.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ "stringValue": "A String", # A UTF-8 encoded string value. When indexed is true, may have at most 500 characters.
+ "indexed": True or False, # If the value should be indexed.
+ #
+ # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
+ "blobValue": "A String", # A blob value. May be a maximum of 1,000,000 bytes. When indexed is true, may have at most 500 bytes.
+ "booleanValue": True or False, # A boolean value.
+ "blobKeyValue": "A String", # A blob key value.
+ },
+ ],
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty. The path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity. A kind matching regex "__.*__" is reserved/read-only. A kind must not contain more than 500 characters. Cannot be "".
+ "id": "A String", # The ID of the entity. Never equal to zero. Values less than zero are discouraged and will not be supported in the future.
+ "name": "A String", # The name of the entity. A name matching regex "__.*__" is reserved/read-only. A name must not be more than 500 characters. Cannot be "".
+ },
+ ],
+ "partitionId": { # An identifier for a particular subset of entities. # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
+ #
+ # Entities are partitioned into various subsets, each used by different datasets and different namespaces within a dataset and so forth.
+ "namespace": "A String", # The namespace.
+ "datasetId": "A String", # The dataset ID.
+ },
+ },
+ },
+ },
+ ],
+ "skippedResults": 42, # The number of results skipped because of Query.offset.
+ "endCursor": "A String", # A cursor that points to the position after the last result in the batch. May be absent. TODO(arfuller): Once all plans produce cursors update documentation here.
+ "entityResultType": "A String", # The result type for every entity in entityResults. full for full entities, projection for entities with only projected properties, keyOnly for entities with only a key.
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v1beta3.html b/docs/dyn/datastore_v1beta1.html
similarity index 90%
copy from docs/dyn/logging_v1beta3.html
copy to docs/dyn/datastore_v1beta1.html
index db3cf63..fc21e15 100644
--- a/docs/dyn/logging_v1beta3.html
+++ b/docs/dyn/datastore_v1beta1.html
@@ -72,12 +72,12 @@
</style>
-<h1><a href="logging_v1beta3.html">Google Cloud Logging API</a></h1>
+<h1><a href="datastore_v1beta1.html">Google Cloud Datastore API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="logging_v1beta3.projects.html">projects()</a></code>
+ <code><a href="datastore_v1beta1.datasets.html">datasets()</a></code>
</p>
-<p class="firstline">Returns the projects Resource.</p>
+<p class="firstline">Returns the datasets Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/datastore_v1beta3.projects.html b/docs/dyn/datastore_v1beta3.projects.html
index 7e868f5..87bf75b 100644
--- a/docs/dyn/datastore_v1beta3.projects.html
+++ b/docs/dyn/datastore_v1beta3.projects.html
@@ -103,7 +103,7 @@
body: object, The request body. (required)
The object takes the form of:
-{ # The request for google.datastore.v1beta3.Datastore.AllocateIds.
+{ # The request for Datastore.AllocateIds.
"keys": [ # A list of keys with incomplete key paths for which to allocate IDs.
# No key may be reserved/read-only.
{ # A unique identifier for an entity.
@@ -134,13 +134,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -179,7 +179,7 @@
Returns:
An object of the form:
- { # The response for google.datastore.v1beta3.Datastore.AllocateIds.
+ { # The response for Datastore.AllocateIds.
"keys": [ # The keys specified in the request (in the same order), each with
# its key path completed with a newly allocated ID.
{ # A unique identifier for an entity.
@@ -210,13 +210,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -257,7 +257,7 @@
body: object, The request body. (required)
The object takes the form of:
-{ # The request for google.datastore.v1beta3.Datastore.BeginTransaction.
+{ # The request for Datastore.BeginTransaction.
}
x__xgafv: string, V1 error format.
@@ -268,7 +268,7 @@
Returns:
An object of the form:
- { # The response for google.datastore.v1beta3.Datastore.BeginTransaction.
+ { # The response for Datastore.BeginTransaction.
"transaction": "A String", # The transaction identifier (always present).
}</pre>
</div>
@@ -283,10 +283,11 @@
body: object, The request body. (required)
The object takes the form of:
-{ # The request for google.datastore.v1beta3.Datastore.Commit.
+{ # The request for Datastore.Commit.
"transaction": "A String", # The identifier of the transaction associated with the commit. A
# transaction identifier is returned by a call to
- # BeginTransaction.
+ # Datastore.BeginTransaction.
+ "mode": "A String", # The type of commit to perform. Defaults to `TRANSACTIONAL`.
"mutations": [ # The mutations to perform.
#
# When mode is `TRANSACTIONAL`, mutations affecting a single entity are
@@ -356,13 +357,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -426,7 +427,7 @@
#
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
- # [-180.0, 180.0] and [-90.0, 90.0], respectively."""
+ # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
@@ -486,453 +487,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
- },
- ],
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
- # ID and namespace ID.
- # Queries are scoped to a single partition.
- # by project and namespace, however the namespace ID may be empty.
- #
- # A partition ID contains several dimensions:
- # project ID and namespace ID.
- #
- # Partition dimensions:
- #
- # - May be `""`.
- # - Must be valid UTF-8 bytes.
- # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
- # If the value of any dimension matches regex `__.*__`, the partition is
- # reserved/read-only.
- # A reserved/read-only partition ID is forbidden in certain documented
- # contexts.
- #
- # Foreign partition IDs (in which the project ID does
- # not match the context project ID ) are discouraged.
- # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
- "projectId": "A String", # The ID of the project to which the entities belong.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- },
- },
- },
- "upsert": { # A Datastore data object. # The entity to upsert. The entity may or may not already exist.
- # The entity key's final path element may be incomplete.
- #
- # An entity is limited to 1 megabyte when stored. That _roughly_
- # corresponds to a limit of 1 megabyte for the serialized form of this
- # message.
- "properties": { # The entity's properties.
- # The map's keys are property names.
- # A property name matching regex `__.*__` is reserved.
- # A reserved property name is forbidden in certain documented contexts.
- # The name must not contain more than 500 characters.
- # The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated
- # metadata.
- "booleanValue": True or False, # A boolean value.
- "entityValue": # Object with schema name: Entity # An entity value.
- #
- # - May have no key.
- # - May have a key with an incomplete key path.
- # - May have a reserved/read-only key.
- "timestampValue": "A String", # A timestamp value.
- # When stored in the Datastore, precise only to microseconds;
- # any additional precision is rounded down.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
- # explicitly.
- "doubleValue": 3.14, # A double value.
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "keyValue": { # A unique identifier for an entity. # A key value.
- # If a key's partition ID or any of its path kinds or names are
- # reserved/read-only, the key is reserved/read-only.
- # A reserved/read-only key is forbidden in certain documented contexts.
- "path": [ # The entity path.
- # An entity path consists of one or more elements composed of a kind and a
- # string or numerical identifier, which identify entities. The first
- # element identifies a _root entity_, the second element identifies
- # a _child_ of the root entity, the third element identifies a child of the
- # second entity, and so forth. The entities identified by all prefixes of
- # the path are called the element's _ancestors_.
- #
- # An entity path is always fully complete: *all* of the entity's ancestors
- # are required to be in the path along with the entity identifier itself.
- # The only exception is that in some documented cases, the identifier in the
- # last path element (for the entity) itself may be omitted. For example,
- # the last path element of the key of `Mutation.insert` may have no
- # identifier.
- #
- # A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # If either name or ID is set, the element is complete.
- # If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity.
- # A kind matching regex `__.*__` is reserved/read-only.
- # A kind must not contain more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "name": "A String", # The name of the entity.
- # A name matching regex `__.*__` is reserved/read-only.
- # A name must not be more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
- },
- ],
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
- # ID and namespace ID.
- # Queries are scoped to a single partition.
- # by project and namespace, however the namespace ID may be empty.
- #
- # A partition ID contains several dimensions:
- # project ID and namespace ID.
- #
- # Partition dimensions:
- #
- # - May be `""`.
- # - Must be valid UTF-8 bytes.
- # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
- # If the value of any dimension matches regex `__.*__`, the partition is
- # reserved/read-only.
- # A reserved/read-only partition ID is forbidden in certain documented
- # contexts.
- #
- # Foreign partition IDs (in which the project ID does
- # not match the context project ID ) are discouraged.
- # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
- "projectId": "A String", # The ID of the project to which the entities belong.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- },
- },
- "blobValue": "A String", # A blob value.
- # May have at most 1,000,000 bytes.
- # When `exclude_from_indexes` is false, may have at most 1500 bytes.
- # In JSON requests, must be base64-encoded.
- "stringValue": "A String", # A UTF-8 encoded string value.
- # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
- # Otherwise, may be set to at least 1,000,000 bytes.
- "nullValue": "A String", # A null value.
- "arrayValue": { # An array value. # An array value.
- # Cannot contain another array value.
- # A `Value` instance that sets field `array_value` must not set fields
- # `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array.
- # The order of this array may not be preserved if it contains a mix of
- # indexed and unindexed values.
- # Object with schema name: Value
- ],
- },
- "integerValue": "A String", # An integer value.
- "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
- # of doubles representing degrees latitude and degrees longitude. Unless
- # specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
- #
- # Example of normalization code in Python:
- #
- # def NormalizeLongitude(longitude):
- # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
- # q, r = divmod(longitude, 360.0)
- # if r > 180.0 or (r == 180.0 and q <= -1.0):
- # return r - 360.0
- # return r
- #
- # def NormalizeLatLng(latitude, longitude):
- # """Wraps decimal degrees latitude and longitude to
- # [-180.0, 180.0] and [-90.0, 90.0], respectively."""
- # r = latitude % 360.0
- # if r <= 90.0:
- # return r, NormalizeLongitude(longitude)
- # elif r >= 270.0:
- # return r - 360, NormalizeLongitude(longitude)
- # else:
- # return 180 - r, NormalizeLongitude(longitude + 180.0)
- #
- # assert 180.0 == NormalizeLongitude(180.0)
- # assert -180.0 == NormalizeLongitude(-180.0)
- # assert -179.0 == NormalizeLongitude(181.0)
- # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
- # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
- # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
- # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
- # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
- # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
- # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
- # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
- # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
- # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- },
- },
- "key": { # A unique identifier for an entity. # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example,
- # an entity in `Value.entity_value` may have no key).
- # An entity's kind is its key path's last element's kind,
- # or null if it has no key.
- # If a key's partition ID or any of its path kinds or names are
- # reserved/read-only, the key is reserved/read-only.
- # A reserved/read-only key is forbidden in certain documented contexts.
- "path": [ # The entity path.
- # An entity path consists of one or more elements composed of a kind and a
- # string or numerical identifier, which identify entities. The first
- # element identifies a _root entity_, the second element identifies
- # a _child_ of the root entity, the third element identifies a child of the
- # second entity, and so forth. The entities identified by all prefixes of
- # the path are called the element's _ancestors_.
- #
- # An entity path is always fully complete: *all* of the entity's ancestors
- # are required to be in the path along with the entity identifier itself.
- # The only exception is that in some documented cases, the identifier in the
- # last path element (for the entity) itself may be omitted. For example,
- # the last path element of the key of `Mutation.insert` may have no
- # identifier.
- #
- # A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # If either name or ID is set, the element is complete.
- # If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity.
- # A kind matching regex `__.*__` is reserved/read-only.
- # A kind must not contain more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "name": "A String", # The name of the entity.
- # A name matching regex `__.*__` is reserved/read-only.
- # A name must not be more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
- },
- ],
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
- # ID and namespace ID.
- # Queries are scoped to a single partition.
- # by project and namespace, however the namespace ID may be empty.
- #
- # A partition ID contains several dimensions:
- # project ID and namespace ID.
- #
- # Partition dimensions:
- #
- # - May be `""`.
- # - Must be valid UTF-8 bytes.
- # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
- # If the value of any dimension matches regex `__.*__`, the partition is
- # reserved/read-only.
- # A reserved/read-only partition ID is forbidden in certain documented
- # contexts.
- #
- # Foreign partition IDs (in which the project ID does
- # not match the context project ID ) are discouraged.
- # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
- "projectId": "A String", # The ID of the project to which the entities belong.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- },
- },
- },
- "update": { # A Datastore data object. # The entity to update. The entity must already exist.
- # Must have a complete key path.
- #
- # An entity is limited to 1 megabyte when stored. That _roughly_
- # corresponds to a limit of 1 megabyte for the serialized form of this
- # message.
- "properties": { # The entity's properties.
- # The map's keys are property names.
- # A property name matching regex `__.*__` is reserved.
- # A reserved property name is forbidden in certain documented contexts.
- # The name must not contain more than 500 characters.
- # The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated
- # metadata.
- "booleanValue": True or False, # A boolean value.
- "entityValue": # Object with schema name: Entity # An entity value.
- #
- # - May have no key.
- # - May have a key with an incomplete key path.
- # - May have a reserved/read-only key.
- "timestampValue": "A String", # A timestamp value.
- # When stored in the Datastore, precise only to microseconds;
- # any additional precision is rounded down.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
- # explicitly.
- "doubleValue": 3.14, # A double value.
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "keyValue": { # A unique identifier for an entity. # A key value.
- # If a key's partition ID or any of its path kinds or names are
- # reserved/read-only, the key is reserved/read-only.
- # A reserved/read-only key is forbidden in certain documented contexts.
- "path": [ # The entity path.
- # An entity path consists of one or more elements composed of a kind and a
- # string or numerical identifier, which identify entities. The first
- # element identifies a _root entity_, the second element identifies
- # a _child_ of the root entity, the third element identifies a child of the
- # second entity, and so forth. The entities identified by all prefixes of
- # the path are called the element's _ancestors_.
- #
- # An entity path is always fully complete: *all* of the entity's ancestors
- # are required to be in the path along with the entity identifier itself.
- # The only exception is that in some documented cases, the identifier in the
- # last path element (for the entity) itself may be omitted. For example,
- # the last path element of the key of `Mutation.insert` may have no
- # identifier.
- #
- # A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # If either name or ID is set, the element is complete.
- # If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity.
- # A kind matching regex `__.*__` is reserved/read-only.
- # A kind must not contain more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "name": "A String", # The name of the entity.
- # A name matching regex `__.*__` is reserved/read-only.
- # A name must not be more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
- },
- ],
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
- # ID and namespace ID.
- # Queries are scoped to a single partition.
- # by project and namespace, however the namespace ID may be empty.
- #
- # A partition ID contains several dimensions:
- # project ID and namespace ID.
- #
- # Partition dimensions:
- #
- # - May be `""`.
- # - Must be valid UTF-8 bytes.
- # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
- # If the value of any dimension matches regex `__.*__`, the partition is
- # reserved/read-only.
- # A reserved/read-only partition ID is forbidden in certain documented
- # contexts.
- #
- # Foreign partition IDs (in which the project ID does
- # not match the context project ID ) are discouraged.
- # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
- "projectId": "A String", # The ID of the project to which the entities belong.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- },
- },
- "blobValue": "A String", # A blob value.
- # May have at most 1,000,000 bytes.
- # When `exclude_from_indexes` is false, may have at most 1500 bytes.
- # In JSON requests, must be base64-encoded.
- "stringValue": "A String", # A UTF-8 encoded string value.
- # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
- # Otherwise, may be set to at least 1,000,000 bytes.
- "nullValue": "A String", # A null value.
- "arrayValue": { # An array value. # An array value.
- # Cannot contain another array value.
- # A `Value` instance that sets field `array_value` must not set fields
- # `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array.
- # The order of this array may not be preserved if it contains a mix of
- # indexed and unindexed values.
- # Object with schema name: Value
- ],
- },
- "integerValue": "A String", # An integer value.
- "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
- # of doubles representing degrees latitude and degrees longitude. Unless
- # specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
- #
- # Example of normalization code in Python:
- #
- # def NormalizeLongitude(longitude):
- # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
- # q, r = divmod(longitude, 360.0)
- # if r > 180.0 or (r == 180.0 and q <= -1.0):
- # return r - 360.0
- # return r
- #
- # def NormalizeLatLng(latitude, longitude):
- # """Wraps decimal degrees latitude and longitude to
- # [-180.0, 180.0] and [-90.0, 90.0], respectively."""
- # r = latitude % 360.0
- # if r <= 90.0:
- # return r, NormalizeLongitude(longitude)
- # elif r >= 270.0:
- # return r - 360, NormalizeLongitude(longitude)
- # else:
- # return 180 - r, NormalizeLongitude(longitude + 180.0)
- #
- # assert 180.0 == NormalizeLongitude(180.0)
- # assert -180.0 == NormalizeLongitude(-180.0)
- # assert -179.0 == NormalizeLongitude(181.0)
- # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
- # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
- # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
- # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
- # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
- # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
- # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
- # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
- # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
- # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- },
- },
- "key": { # A unique identifier for an entity. # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example,
- # an entity in `Value.entity_value` may have no key).
- # An entity's kind is its key path's last element's kind,
- # or null if it has no key.
- # If a key's partition ID or any of its path kinds or names are
- # reserved/read-only, the key is reserved/read-only.
- # A reserved/read-only key is forbidden in certain documented contexts.
- "path": [ # The entity path.
- # An entity path consists of one or more elements composed of a kind and a
- # string or numerical identifier, which identify entities. The first
- # element identifies a _root entity_, the second element identifies
- # a _child_ of the root entity, the third element identifies a child of the
- # second entity, and so forth. The entities identified by all prefixes of
- # the path are called the element's _ancestors_.
- #
- # An entity path is always fully complete: *all* of the entity's ancestors
- # are required to be in the path along with the entity identifier itself.
- # The only exception is that in some documented cases, the identifier in the
- # last path element (for the entity) itself may be omitted. For example,
- # the last path element of the key of `Mutation.insert` may have no
- # identifier.
- #
- # A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # If either name or ID is set, the element is complete.
- # If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity.
- # A kind matching regex `__.*__` is reserved/read-only.
- # A kind must not contain more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "name": "A String", # The name of the entity.
- # A name matching regex `__.*__` is reserved/read-only.
- # A name must not be more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -990,13 +551,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -1024,9 +585,450 @@
"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
},
},
+ "update": { # A Datastore data object. # The entity to update. The entity must already exist.
+ # Must have a complete key path.
+ #
+ # An entity is limited to 1 megabyte when stored. That _roughly_
+ # corresponds to a limit of 1 megabyte for the serialized form of this
+ # message.
+ "properties": { # The entity's properties.
+ # The map's keys are property names.
+ # A property name matching regex `__.*__` is reserved.
+ # A reserved property name is forbidden in certain documented contexts.
+ # The name must not contain more than 500 characters.
+ # The name cannot be `""`.
+ "a_key": { # A message that can hold any of the supported value types and associated
+ # metadata.
+ "booleanValue": True or False, # A boolean value.
+ "entityValue": # Object with schema name: Entity # An entity value.
+ #
+ # - May have no key.
+ # - May have a key with an incomplete key path.
+ # - May have a reserved/read-only key.
+ "timestampValue": "A String", # A timestamp value.
+ # When stored in the Datastore, precise only to microseconds;
+ # any additional precision is rounded down.
+ "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
+ # explicitly.
+ "doubleValue": 3.14, # A double value.
+ "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ # If a key's partition ID or any of its path kinds or names are
+ # reserved/read-only, the key is reserved/read-only.
+ # A reserved/read-only key is forbidden in certain documented contexts.
+ "path": [ # The entity path.
+ # An entity path consists of one or more elements composed of a kind and a
+ # string or numerical identifier, which identify entities. The first
+ # element identifies a _root entity_, the second element identifies
+ # a _child_ of the root entity, the third element identifies a child of the
+ # second entity, and so forth. The entities identified by all prefixes of
+ # the path are called the element's _ancestors_.
+ #
+ # An entity path is always fully complete: *all* of the entity's ancestors
+ # are required to be in the path along with the entity identifier itself.
+ # The only exception is that in some documented cases, the identifier in the
+ # last path element (for the entity) itself may be omitted. For example,
+ # the last path element of the key of `Mutation.insert` may have no
+ # identifier.
+ #
+ # A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # If either name or ID is set, the element is complete.
+ # If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity.
+ # A kind matching regex `__.*__` is reserved/read-only.
+ # A kind must not contain more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
+ "name": "A String", # The name of the entity.
+ # A name matching regex `__.*__` is reserved/read-only.
+ # A name must not be more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ },
+ ],
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
+ # ID and namespace ID.
+ # Queries are scoped to a single partition.
+ # by project and namespace, however the namespace ID may be empty.
+ #
+ # A partition ID contains several dimensions:
+ # project ID and namespace ID.
+ #
+ # Partition dimensions:
+ #
+ # - May be `""`.
+ # - Must be valid UTF-8 bytes.
+ # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
+ # If the value of any dimension matches regex `__.*__`, the partition is
+ # reserved/read-only.
+ # A reserved/read-only partition ID is forbidden in certain documented
+ # contexts.
+ #
+ # Foreign partition IDs (in which the project ID does
+ # not match the context project ID ) are discouraged.
+ # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ },
+ },
+ "blobValue": "A String", # A blob value.
+ # May have at most 1,000,000 bytes.
+ # When `exclude_from_indexes` is false, may have at most 1500 bytes.
+ # In JSON requests, must be base64-encoded.
+ "stringValue": "A String", # A UTF-8 encoded string value.
+ # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
+ # Otherwise, may be set to at least 1,000,000 bytes.
+ "nullValue": "A String", # A null value.
+ "arrayValue": { # An array value. # An array value.
+ # Cannot contain another array value.
+ # A `Value` instance that sets field `array_value` must not set fields
+ # `meaning` or `exclude_from_indexes`.
+ "values": [ # Values in the array.
+ # The order of this array may not be preserved if it contains a mix of
+ # indexed and unindexed values.
+ # Object with schema name: Value
+ ],
+ },
+ "integerValue": "A String", # An integer value.
+ "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
+ # of doubles representing degrees latitude and degrees longitude. Unless
+ # specified otherwise, this must conform to the
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
+ #
+ # Example of normalization code in Python:
+ #
+ # def NormalizeLongitude(longitude):
+ # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
+ # q, r = divmod(longitude, 360.0)
+ # if r > 180.0 or (r == 180.0 and q <= -1.0):
+ # return r - 360.0
+ # return r
+ #
+ # def NormalizeLatLng(latitude, longitude):
+ # """Wraps decimal degrees latitude and longitude to
+ # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
+ # r = latitude % 360.0
+ # if r <= 90.0:
+ # return r, NormalizeLongitude(longitude)
+ # elif r >= 270.0:
+ # return r - 360, NormalizeLongitude(longitude)
+ # else:
+ # return 180 - r, NormalizeLongitude(longitude + 180.0)
+ #
+ # assert 180.0 == NormalizeLongitude(180.0)
+ # assert -180.0 == NormalizeLongitude(-180.0)
+ # assert -179.0 == NormalizeLongitude(181.0)
+ # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
+ # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
+ # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
+ # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
+ # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
+ # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
+ # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
+ # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
+ # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
+ # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example,
+ # an entity in `Value.entity_value` may have no key).
+ # An entity's kind is its key path's last element's kind,
+ # or null if it has no key.
+ # If a key's partition ID or any of its path kinds or names are
+ # reserved/read-only, the key is reserved/read-only.
+ # A reserved/read-only key is forbidden in certain documented contexts.
+ "path": [ # The entity path.
+ # An entity path consists of one or more elements composed of a kind and a
+ # string or numerical identifier, which identify entities. The first
+ # element identifies a _root entity_, the second element identifies
+ # a _child_ of the root entity, the third element identifies a child of the
+ # second entity, and so forth. The entities identified by all prefixes of
+ # the path are called the element's _ancestors_.
+ #
+ # An entity path is always fully complete: *all* of the entity's ancestors
+ # are required to be in the path along with the entity identifier itself.
+ # The only exception is that in some documented cases, the identifier in the
+ # last path element (for the entity) itself may be omitted. For example,
+ # the last path element of the key of `Mutation.insert` may have no
+ # identifier.
+ #
+ # A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # If either name or ID is set, the element is complete.
+ # If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity.
+ # A kind matching regex `__.*__` is reserved/read-only.
+ # A kind must not contain more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
+ "name": "A String", # The name of the entity.
+ # A name matching regex `__.*__` is reserved/read-only.
+ # A name must not be more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ },
+ ],
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
+ # ID and namespace ID.
+ # Queries are scoped to a single partition.
+ # by project and namespace, however the namespace ID may be empty.
+ #
+ # A partition ID contains several dimensions:
+ # project ID and namespace ID.
+ #
+ # Partition dimensions:
+ #
+ # - May be `""`.
+ # - Must be valid UTF-8 bytes.
+ # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
+ # If the value of any dimension matches regex `__.*__`, the partition is
+ # reserved/read-only.
+ # A reserved/read-only partition ID is forbidden in certain documented
+ # contexts.
+ #
+ # Foreign partition IDs (in which the project ID does
+ # not match the context project ID ) are discouraged.
+ # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ },
+ },
+ },
+ "baseVersion": "A String", # The version of the entity that this mutation is being applied to. If this
+ # does not match the current version on the server, the mutation conflicts.
+ "upsert": { # A Datastore data object. # The entity to upsert. The entity may or may not already exist.
+ # The entity key's final path element may be incomplete.
+ #
+ # An entity is limited to 1 megabyte when stored. That _roughly_
+ # corresponds to a limit of 1 megabyte for the serialized form of this
+ # message.
+ "properties": { # The entity's properties.
+ # The map's keys are property names.
+ # A property name matching regex `__.*__` is reserved.
+ # A reserved property name is forbidden in certain documented contexts.
+ # The name must not contain more than 500 characters.
+ # The name cannot be `""`.
+ "a_key": { # A message that can hold any of the supported value types and associated
+ # metadata.
+ "booleanValue": True or False, # A boolean value.
+ "entityValue": # Object with schema name: Entity # An entity value.
+ #
+ # - May have no key.
+ # - May have a key with an incomplete key path.
+ # - May have a reserved/read-only key.
+ "timestampValue": "A String", # A timestamp value.
+ # When stored in the Datastore, precise only to microseconds;
+ # any additional precision is rounded down.
+ "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
+ # explicitly.
+ "doubleValue": 3.14, # A double value.
+ "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ # If a key's partition ID or any of its path kinds or names are
+ # reserved/read-only, the key is reserved/read-only.
+ # A reserved/read-only key is forbidden in certain documented contexts.
+ "path": [ # The entity path.
+ # An entity path consists of one or more elements composed of a kind and a
+ # string or numerical identifier, which identify entities. The first
+ # element identifies a _root entity_, the second element identifies
+ # a _child_ of the root entity, the third element identifies a child of the
+ # second entity, and so forth. The entities identified by all prefixes of
+ # the path are called the element's _ancestors_.
+ #
+ # An entity path is always fully complete: *all* of the entity's ancestors
+ # are required to be in the path along with the entity identifier itself.
+ # The only exception is that in some documented cases, the identifier in the
+ # last path element (for the entity) itself may be omitted. For example,
+ # the last path element of the key of `Mutation.insert` may have no
+ # identifier.
+ #
+ # A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # If either name or ID is set, the element is complete.
+ # If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity.
+ # A kind matching regex `__.*__` is reserved/read-only.
+ # A kind must not contain more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
+ "name": "A String", # The name of the entity.
+ # A name matching regex `__.*__` is reserved/read-only.
+ # A name must not be more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ },
+ ],
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
+ # ID and namespace ID.
+ # Queries are scoped to a single partition.
+ # by project and namespace, however the namespace ID may be empty.
+ #
+ # A partition ID contains several dimensions:
+ # project ID and namespace ID.
+ #
+ # Partition dimensions:
+ #
+ # - May be `""`.
+ # - Must be valid UTF-8 bytes.
+ # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
+ # If the value of any dimension matches regex `__.*__`, the partition is
+ # reserved/read-only.
+ # A reserved/read-only partition ID is forbidden in certain documented
+ # contexts.
+ #
+ # Foreign partition IDs (in which the project ID does
+ # not match the context project ID ) are discouraged.
+ # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ },
+ },
+ "blobValue": "A String", # A blob value.
+ # May have at most 1,000,000 bytes.
+ # When `exclude_from_indexes` is false, may have at most 1500 bytes.
+ # In JSON requests, must be base64-encoded.
+ "stringValue": "A String", # A UTF-8 encoded string value.
+ # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
+ # Otherwise, may be set to at least 1,000,000 bytes.
+ "nullValue": "A String", # A null value.
+ "arrayValue": { # An array value. # An array value.
+ # Cannot contain another array value.
+ # A `Value` instance that sets field `array_value` must not set fields
+ # `meaning` or `exclude_from_indexes`.
+ "values": [ # Values in the array.
+ # The order of this array may not be preserved if it contains a mix of
+ # indexed and unindexed values.
+ # Object with schema name: Value
+ ],
+ },
+ "integerValue": "A String", # An integer value.
+ "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
+ # of doubles representing degrees latitude and degrees longitude. Unless
+ # specified otherwise, this must conform to the
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
+ #
+ # Example of normalization code in Python:
+ #
+ # def NormalizeLongitude(longitude):
+ # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
+ # q, r = divmod(longitude, 360.0)
+ # if r > 180.0 or (r == 180.0 and q <= -1.0):
+ # return r - 360.0
+ # return r
+ #
+ # def NormalizeLatLng(latitude, longitude):
+ # """Wraps decimal degrees latitude and longitude to
+ # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
+ # r = latitude % 360.0
+ # if r <= 90.0:
+ # return r, NormalizeLongitude(longitude)
+ # elif r >= 270.0:
+ # return r - 360, NormalizeLongitude(longitude)
+ # else:
+ # return 180 - r, NormalizeLongitude(longitude + 180.0)
+ #
+ # assert 180.0 == NormalizeLongitude(180.0)
+ # assert -180.0 == NormalizeLongitude(-180.0)
+ # assert -179.0 == NormalizeLongitude(181.0)
+ # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
+ # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
+ # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
+ # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
+ # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
+ # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
+ # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
+ # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
+ # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
+ # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example,
+ # an entity in `Value.entity_value` may have no key).
+ # An entity's kind is its key path's last element's kind,
+ # or null if it has no key.
+ # If a key's partition ID or any of its path kinds or names are
+ # reserved/read-only, the key is reserved/read-only.
+ # A reserved/read-only key is forbidden in certain documented contexts.
+ "path": [ # The entity path.
+ # An entity path consists of one or more elements composed of a kind and a
+ # string or numerical identifier, which identify entities. The first
+ # element identifies a _root entity_, the second element identifies
+ # a _child_ of the root entity, the third element identifies a child of the
+ # second entity, and so forth. The entities identified by all prefixes of
+ # the path are called the element's _ancestors_.
+ #
+ # An entity path is always fully complete: *all* of the entity's ancestors
+ # are required to be in the path along with the entity identifier itself.
+ # The only exception is that in some documented cases, the identifier in the
+ # last path element (for the entity) itself may be omitted. For example,
+ # the last path element of the key of `Mutation.insert` may have no
+ # identifier.
+ #
+ # A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # If either name or ID is set, the element is complete.
+ # If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity.
+ # A kind matching regex `__.*__` is reserved/read-only.
+ # A kind must not contain more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
+ "name": "A String", # The name of the entity.
+ # A name matching regex `__.*__` is reserved/read-only.
+ # A name must not be more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ },
+ ],
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
+ # ID and namespace ID.
+ # Queries are scoped to a single partition.
+ # by project and namespace, however the namespace ID may be empty.
+ #
+ # A partition ID contains several dimensions:
+ # project ID and namespace ID.
+ #
+ # Partition dimensions:
+ #
+ # - May be `""`.
+ # - Must be valid UTF-8 bytes.
+ # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
+ # If the value of any dimension matches regex `__.*__`, the partition is
+ # reserved/read-only.
+ # A reserved/read-only partition ID is forbidden in certain documented
+ # contexts.
+ #
+ # Foreign partition IDs (in which the project ID does
+ # not match the context project ID ) are discouraged.
+ # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ },
+ },
+ },
},
],
- "mode": "A String", # The type of commit to perform. Defaults to `TRANSACTIONAL`.
}
x__xgafv: string, V1 error format.
@@ -1037,10 +1039,17 @@
Returns:
An object of the form:
- { # The response for google.datastore.v1beta3.Datastore.Commit.
+ { # The response for Datastore.Commit.
"mutationResults": [ # The result of performing the mutations.
# The i-th mutation result corresponds to the i-th mutation in the request.
{ # The result of applying a mutation.
+ "version": "A String", # The version of the entity on the server after processing the mutation. If
+ # the mutation doesn't change anything on the server, then the version will
+ # be the version of the current entity or, if no entity is present, a version
+ # that is strictly greater than the version of any previous entity and less
+ # than the version of any possible future entity.
+ "conflictDetected": True or False, # Whether a conflict was detected for this mutation. Always false when a
+ # conflict detection strategy field is not set in the mutation.
"key": { # A unique identifier for an entity. # The automatically allocated key.
# Set only when the mutation allocated a key.
# If a key's partition ID or any of its path kinds or names are
@@ -1070,13 +1079,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -1120,7 +1129,7 @@
body: object, The request body. (required)
The object takes the form of:
-{ # The request for google.datastore.v1beta3.Datastore.Lookup.
+{ # The request for Datastore.Lookup.
"keys": [ # Keys of entities to look up.
{ # A unique identifier for an entity.
# If a key's partition ID or any of its path kinds or names are
@@ -1150,13 +1159,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -1188,7 +1197,7 @@
"readOptions": { # The options shared by read requests. # The options for this lookup request.
"transaction": "A String", # The identifier of the transaction in which to read. A
# transaction identifier is returned by a call to
- # BeginTransaction.
+ # Datastore.BeginTransaction.
"readConsistency": "A String", # The non-transactional read consistency to use.
# Cannot be set to `STRONG` for global queries.
},
@@ -1202,13 +1211,22 @@
Returns:
An object of the form:
- { # The response for google.datastore.v1beta3.Datastore.Lookup.
+ { # The response for Datastore.Lookup.
"found": [ # Entities found as `ResultType.FULL` entities. The order of results in this
# field is undefined and has no relation to the order of the keys in the
# input.
{ # The result of fetching an entity from Datastore.
"cursor": "A String", # A cursor that points to the position after the result entity.
# Set only when the `EntityResult` is part of a `QueryResultBatch` message.
+ "version": "A String", # The version of the entity, a strictly positive number that monotonically
+ # increases with changes to the entity.
+ #
+ # This field is set for `FULL` entity
+ # results.
+ #
+ # For missing entities in `LookupResponse`, this
+ # is the version of the snapshot that was used to look up the entity, and it
+ # is always set except for eventually consistent reads.
"entity": { # A Datastore data object. # The resulting entity.
#
# An entity is limited to 1 megabyte when stored. That _roughly_
@@ -1263,13 +1281,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -1333,7 +1351,7 @@
#
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
- # [-180.0, 180.0] and [-90.0, 90.0], respectively."""
+ # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
@@ -1393,240 +1411,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
- },
- ],
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
- # ID and namespace ID.
- # Queries are scoped to a single partition.
- # by project and namespace, however the namespace ID may be empty.
- #
- # A partition ID contains several dimensions:
- # project ID and namespace ID.
- #
- # Partition dimensions:
- #
- # - May be `""`.
- # - Must be valid UTF-8 bytes.
- # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
- # If the value of any dimension matches regex `__.*__`, the partition is
- # reserved/read-only.
- # A reserved/read-only partition ID is forbidden in certain documented
- # contexts.
- #
- # Foreign partition IDs (in which the project ID does
- # not match the context project ID ) are discouraged.
- # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
- "projectId": "A String", # The ID of the project to which the entities belong.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- },
- },
- },
- },
- ],
- "missing": [ # Entities not found as `ResultType.KEY_ONLY` entities. The order of results
- # in this field is undefined and has no relation to the order of the keys
- # in the input.
- { # The result of fetching an entity from Datastore.
- "cursor": "A String", # A cursor that points to the position after the result entity.
- # Set only when the `EntityResult` is part of a `QueryResultBatch` message.
- "entity": { # A Datastore data object. # The resulting entity.
- #
- # An entity is limited to 1 megabyte when stored. That _roughly_
- # corresponds to a limit of 1 megabyte for the serialized form of this
- # message.
- "properties": { # The entity's properties.
- # The map's keys are property names.
- # A property name matching regex `__.*__` is reserved.
- # A reserved property name is forbidden in certain documented contexts.
- # The name must not contain more than 500 characters.
- # The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated
- # metadata.
- "booleanValue": True or False, # A boolean value.
- "entityValue": # Object with schema name: Entity # An entity value.
- #
- # - May have no key.
- # - May have a key with an incomplete key path.
- # - May have a reserved/read-only key.
- "timestampValue": "A String", # A timestamp value.
- # When stored in the Datastore, precise only to microseconds;
- # any additional precision is rounded down.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
- # explicitly.
- "doubleValue": 3.14, # A double value.
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "keyValue": { # A unique identifier for an entity. # A key value.
- # If a key's partition ID or any of its path kinds or names are
- # reserved/read-only, the key is reserved/read-only.
- # A reserved/read-only key is forbidden in certain documented contexts.
- "path": [ # The entity path.
- # An entity path consists of one or more elements composed of a kind and a
- # string or numerical identifier, which identify entities. The first
- # element identifies a _root entity_, the second element identifies
- # a _child_ of the root entity, the third element identifies a child of the
- # second entity, and so forth. The entities identified by all prefixes of
- # the path are called the element's _ancestors_.
- #
- # An entity path is always fully complete: *all* of the entity's ancestors
- # are required to be in the path along with the entity identifier itself.
- # The only exception is that in some documented cases, the identifier in the
- # last path element (for the entity) itself may be omitted. For example,
- # the last path element of the key of `Mutation.insert` may have no
- # identifier.
- #
- # A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # If either name or ID is set, the element is complete.
- # If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity.
- # A kind matching regex `__.*__` is reserved/read-only.
- # A kind must not contain more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "name": "A String", # The name of the entity.
- # A name matching regex `__.*__` is reserved/read-only.
- # A name must not be more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
- },
- ],
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
- # ID and namespace ID.
- # Queries are scoped to a single partition.
- # by project and namespace, however the namespace ID may be empty.
- #
- # A partition ID contains several dimensions:
- # project ID and namespace ID.
- #
- # Partition dimensions:
- #
- # - May be `""`.
- # - Must be valid UTF-8 bytes.
- # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
- # If the value of any dimension matches regex `__.*__`, the partition is
- # reserved/read-only.
- # A reserved/read-only partition ID is forbidden in certain documented
- # contexts.
- #
- # Foreign partition IDs (in which the project ID does
- # not match the context project ID ) are discouraged.
- # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
- "projectId": "A String", # The ID of the project to which the entities belong.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- },
- },
- "blobValue": "A String", # A blob value.
- # May have at most 1,000,000 bytes.
- # When `exclude_from_indexes` is false, may have at most 1500 bytes.
- # In JSON requests, must be base64-encoded.
- "stringValue": "A String", # A UTF-8 encoded string value.
- # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
- # Otherwise, may be set to at least 1,000,000 bytes.
- "nullValue": "A String", # A null value.
- "arrayValue": { # An array value. # An array value.
- # Cannot contain another array value.
- # A `Value` instance that sets field `array_value` must not set fields
- # `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array.
- # The order of this array may not be preserved if it contains a mix of
- # indexed and unindexed values.
- # Object with schema name: Value
- ],
- },
- "integerValue": "A String", # An integer value.
- "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
- # of doubles representing degrees latitude and degrees longitude. Unless
- # specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
- #
- # Example of normalization code in Python:
- #
- # def NormalizeLongitude(longitude):
- # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
- # q, r = divmod(longitude, 360.0)
- # if r > 180.0 or (r == 180.0 and q <= -1.0):
- # return r - 360.0
- # return r
- #
- # def NormalizeLatLng(latitude, longitude):
- # """Wraps decimal degrees latitude and longitude to
- # [-180.0, 180.0] and [-90.0, 90.0], respectively."""
- # r = latitude % 360.0
- # if r <= 90.0:
- # return r, NormalizeLongitude(longitude)
- # elif r >= 270.0:
- # return r - 360, NormalizeLongitude(longitude)
- # else:
- # return 180 - r, NormalizeLongitude(longitude + 180.0)
- #
- # assert 180.0 == NormalizeLongitude(180.0)
- # assert -180.0 == NormalizeLongitude(-180.0)
- # assert -179.0 == NormalizeLongitude(181.0)
- # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
- # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
- # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
- # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
- # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
- # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
- # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
- # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
- # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
- # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- },
- },
- "key": { # A unique identifier for an entity. # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example,
- # an entity in `Value.entity_value` may have no key).
- # An entity's kind is its key path's last element's kind,
- # or null if it has no key.
- # If a key's partition ID or any of its path kinds or names are
- # reserved/read-only, the key is reserved/read-only.
- # A reserved/read-only key is forbidden in certain documented contexts.
- "path": [ # The entity path.
- # An entity path consists of one or more elements composed of a kind and a
- # string or numerical identifier, which identify entities. The first
- # element identifies a _root entity_, the second element identifies
- # a _child_ of the root entity, the third element identifies a child of the
- # second entity, and so forth. The entities identified by all prefixes of
- # the path are called the element's _ancestors_.
- #
- # An entity path is always fully complete: *all* of the entity's ancestors
- # are required to be in the path along with the entity identifier itself.
- # The only exception is that in some documented cases, the identifier in the
- # last path element (for the entity) itself may be omitted. For example,
- # the last path element of the key of `Mutation.insert` may have no
- # identifier.
- #
- # A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # If either name or ID is set, the element is complete.
- # If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity.
- # A kind matching regex `__.*__` is reserved/read-only.
- # A kind must not contain more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "name": "A String", # The name of the entity.
- # A name matching regex `__.*__` is reserved/read-only.
- # A name must not be more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -1688,13 +1479,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -1723,6 +1514,242 @@
},
},
],
+ "missing": [ # Entities not found as `ResultType.KEY_ONLY` entities. The order of results
+ # in this field is undefined and has no relation to the order of the keys
+ # in the input.
+ { # The result of fetching an entity from Datastore.
+ "cursor": "A String", # A cursor that points to the position after the result entity.
+ # Set only when the `EntityResult` is part of a `QueryResultBatch` message.
+ "version": "A String", # The version of the entity, a strictly positive number that monotonically
+ # increases with changes to the entity.
+ #
+ # This field is set for `FULL` entity
+ # results.
+ #
+ # For missing entities in `LookupResponse`, this
+ # is the version of the snapshot that was used to look up the entity, and it
+ # is always set except for eventually consistent reads.
+ "entity": { # A Datastore data object. # The resulting entity.
+ #
+ # An entity is limited to 1 megabyte when stored. That _roughly_
+ # corresponds to a limit of 1 megabyte for the serialized form of this
+ # message.
+ "properties": { # The entity's properties.
+ # The map's keys are property names.
+ # A property name matching regex `__.*__` is reserved.
+ # A reserved property name is forbidden in certain documented contexts.
+ # The name must not contain more than 500 characters.
+ # The name cannot be `""`.
+ "a_key": { # A message that can hold any of the supported value types and associated
+ # metadata.
+ "booleanValue": True or False, # A boolean value.
+ "entityValue": # Object with schema name: Entity # An entity value.
+ #
+ # - May have no key.
+ # - May have a key with an incomplete key path.
+ # - May have a reserved/read-only key.
+ "timestampValue": "A String", # A timestamp value.
+ # When stored in the Datastore, precise only to microseconds;
+ # any additional precision is rounded down.
+ "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
+ # explicitly.
+ "doubleValue": 3.14, # A double value.
+ "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ # If a key's partition ID or any of its path kinds or names are
+ # reserved/read-only, the key is reserved/read-only.
+ # A reserved/read-only key is forbidden in certain documented contexts.
+ "path": [ # The entity path.
+ # An entity path consists of one or more elements composed of a kind and a
+ # string or numerical identifier, which identify entities. The first
+ # element identifies a _root entity_, the second element identifies
+ # a _child_ of the root entity, the third element identifies a child of the
+ # second entity, and so forth. The entities identified by all prefixes of
+ # the path are called the element's _ancestors_.
+ #
+ # An entity path is always fully complete: *all* of the entity's ancestors
+ # are required to be in the path along with the entity identifier itself.
+ # The only exception is that in some documented cases, the identifier in the
+ # last path element (for the entity) itself may be omitted. For example,
+ # the last path element of the key of `Mutation.insert` may have no
+ # identifier.
+ #
+ # A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # If either name or ID is set, the element is complete.
+ # If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity.
+ # A kind matching regex `__.*__` is reserved/read-only.
+ # A kind must not contain more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
+ "name": "A String", # The name of the entity.
+ # A name matching regex `__.*__` is reserved/read-only.
+ # A name must not be more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ },
+ ],
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
+ # ID and namespace ID.
+ # Queries are scoped to a single partition.
+ # by project and namespace, however the namespace ID may be empty.
+ #
+ # A partition ID contains several dimensions:
+ # project ID and namespace ID.
+ #
+ # Partition dimensions:
+ #
+ # - May be `""`.
+ # - Must be valid UTF-8 bytes.
+ # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
+ # If the value of any dimension matches regex `__.*__`, the partition is
+ # reserved/read-only.
+ # A reserved/read-only partition ID is forbidden in certain documented
+ # contexts.
+ #
+ # Foreign partition IDs (in which the project ID does
+ # not match the context project ID ) are discouraged.
+ # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ },
+ },
+ "blobValue": "A String", # A blob value.
+ # May have at most 1,000,000 bytes.
+ # When `exclude_from_indexes` is false, may have at most 1500 bytes.
+ # In JSON requests, must be base64-encoded.
+ "stringValue": "A String", # A UTF-8 encoded string value.
+ # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
+ # Otherwise, may be set to at least 1,000,000 bytes.
+ "nullValue": "A String", # A null value.
+ "arrayValue": { # An array value. # An array value.
+ # Cannot contain another array value.
+ # A `Value` instance that sets field `array_value` must not set fields
+ # `meaning` or `exclude_from_indexes`.
+ "values": [ # Values in the array.
+ # The order of this array may not be preserved if it contains a mix of
+ # indexed and unindexed values.
+ # Object with schema name: Value
+ ],
+ },
+ "integerValue": "A String", # An integer value.
+ "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
+ # of doubles representing degrees latitude and degrees longitude. Unless
+ # specified otherwise, this must conform to the
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
+ #
+ # Example of normalization code in Python:
+ #
+ # def NormalizeLongitude(longitude):
+ # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
+ # q, r = divmod(longitude, 360.0)
+ # if r > 180.0 or (r == 180.0 and q <= -1.0):
+ # return r - 360.0
+ # return r
+ #
+ # def NormalizeLatLng(latitude, longitude):
+ # """Wraps decimal degrees latitude and longitude to
+ # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
+ # r = latitude % 360.0
+ # if r <= 90.0:
+ # return r, NormalizeLongitude(longitude)
+ # elif r >= 270.0:
+ # return r - 360, NormalizeLongitude(longitude)
+ # else:
+ # return 180 - r, NormalizeLongitude(longitude + 180.0)
+ #
+ # assert 180.0 == NormalizeLongitude(180.0)
+ # assert -180.0 == NormalizeLongitude(-180.0)
+ # assert -179.0 == NormalizeLongitude(181.0)
+ # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
+ # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
+ # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
+ # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
+ # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
+ # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
+ # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
+ # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
+ # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
+ # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
+ },
+ "key": { # A unique identifier for an entity. # The entity's key.
+ #
+ # An entity must have a key, unless otherwise documented (for example,
+ # an entity in `Value.entity_value` may have no key).
+ # An entity's kind is its key path's last element's kind,
+ # or null if it has no key.
+ # If a key's partition ID or any of its path kinds or names are
+ # reserved/read-only, the key is reserved/read-only.
+ # A reserved/read-only key is forbidden in certain documented contexts.
+ "path": [ # The entity path.
+ # An entity path consists of one or more elements composed of a kind and a
+ # string or numerical identifier, which identify entities. The first
+ # element identifies a _root entity_, the second element identifies
+ # a _child_ of the root entity, the third element identifies a child of the
+ # second entity, and so forth. The entities identified by all prefixes of
+ # the path are called the element's _ancestors_.
+ #
+ # An entity path is always fully complete: *all* of the entity's ancestors
+ # are required to be in the path along with the entity identifier itself.
+ # The only exception is that in some documented cases, the identifier in the
+ # last path element (for the entity) itself may be omitted. For example,
+ # the last path element of the key of `Mutation.insert` may have no
+ # identifier.
+ #
+ # A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # If either name or ID is set, the element is complete.
+ # If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity.
+ # A kind matching regex `__.*__` is reserved/read-only.
+ # A kind must not contain more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
+ "name": "A String", # The name of the entity.
+ # A name matching regex `__.*__` is reserved/read-only.
+ # A name must not be more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ },
+ ],
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
+ # ID and namespace ID.
+ # Queries are scoped to a single partition.
+ # by project and namespace, however the namespace ID may be empty.
+ #
+ # A partition ID contains several dimensions:
+ # project ID and namespace ID.
+ #
+ # Partition dimensions:
+ #
+ # - May be `""`.
+ # - Must be valid UTF-8 bytes.
+ # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
+ # If the value of any dimension matches regex `__.*__`, the partition is
+ # reserved/read-only.
+ # A reserved/read-only partition ID is forbidden in certain documented
+ # contexts.
+ #
+ # Foreign partition IDs (in which the project ID does
+ # not match the context project ID ) are discouraged.
+ # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ },
+ },
+ },
+ },
+ ],
}</pre>
</div>
@@ -1735,9 +1762,9 @@
body: object, The request body. (required)
The object takes the form of:
-{ # The request for google.datastore.v1beta3.Datastore.Rollback.
+{ # The request for Datastore.Rollback.
"transaction": "A String", # The transaction identifier, returned by a call to
- # google.datastore.v1beta3.Datastore.BeginTransaction.
+ # Datastore.BeginTransaction.
}
x__xgafv: string, V1 error format.
@@ -1748,7 +1775,7 @@
Returns:
An object of the form:
- { # The response for google.datastore.v1beta3.Datastore.Rollback
+ { # The response for Datastore.Rollback.
# (an empty message).
}</pre>
</div>
@@ -1762,7 +1789,7 @@
body: object, The request body. (required)
The object takes the form of:
-{ # The request for google.datastore.v1beta3.Datastore.RunQuery.
+{ # The request for Datastore.RunQuery.
"query": { # A query for entities. # The query to run.
"startCursor": "A String", # A starting point for the query results. Query cursors are
# returned in query result batches and
@@ -1845,13 +1872,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -1915,7 +1942,7 @@
#
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
- # [-180.0, 180.0] and [-90.0, 90.0], respectively."""
+ # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
@@ -1989,160 +2016,9 @@
"namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
},
"gqlQuery": { # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). # The GQL query to run.
- "queryString": "A String", # A string of the format described
- # [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
- "positionalBindings": [ # Numbered binding site @1 references the first numbered parameter,
- # effectively using 1-based indexing, rather than the usual 0.
- # For each binding site numbered i in `query_string`,
- # there must be an i-th numbered parameter.
- # The inverse must also be true.
- { # A binding parameter for a GQL query.
- "cursor": "A String", # A query cursor. Query cursors are returned in query
- # result batches.
- "value": { # A message that can hold any of the supported value types and associated # A value parameter.
- # metadata.
- "booleanValue": True or False, # A boolean value.
- "entityValue": # Object with schema name: Entity # An entity value.
- #
- # - May have no key.
- # - May have a key with an incomplete key path.
- # - May have a reserved/read-only key.
- "timestampValue": "A String", # A timestamp value.
- # When stored in the Datastore, precise only to microseconds;
- # any additional precision is rounded down.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
- # explicitly.
- "doubleValue": 3.14, # A double value.
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "keyValue": { # A unique identifier for an entity. # A key value.
- # If a key's partition ID or any of its path kinds or names are
- # reserved/read-only, the key is reserved/read-only.
- # A reserved/read-only key is forbidden in certain documented contexts.
- "path": [ # The entity path.
- # An entity path consists of one or more elements composed of a kind and a
- # string or numerical identifier, which identify entities. The first
- # element identifies a _root entity_, the second element identifies
- # a _child_ of the root entity, the third element identifies a child of the
- # second entity, and so forth. The entities identified by all prefixes of
- # the path are called the element's _ancestors_.
- #
- # An entity path is always fully complete: *all* of the entity's ancestors
- # are required to be in the path along with the entity identifier itself.
- # The only exception is that in some documented cases, the identifier in the
- # last path element (for the entity) itself may be omitted. For example,
- # the last path element of the key of `Mutation.insert` may have no
- # identifier.
- #
- # A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # If either name or ID is set, the element is complete.
- # If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity.
- # A kind matching regex `__.*__` is reserved/read-only.
- # A kind must not contain more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "name": "A String", # The name of the entity.
- # A name matching regex `__.*__` is reserved/read-only.
- # A name must not be more than 1500 bytes when UTF-8 encoded.
- # Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
- },
- ],
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
- # ID and namespace ID.
- # Queries are scoped to a single partition.
- # by project and namespace, however the namespace ID may be empty.
- #
- # A partition ID contains several dimensions:
- # project ID and namespace ID.
- #
- # Partition dimensions:
- #
- # - May be `""`.
- # - Must be valid UTF-8 bytes.
- # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
- # If the value of any dimension matches regex `__.*__`, the partition is
- # reserved/read-only.
- # A reserved/read-only partition ID is forbidden in certain documented
- # contexts.
- #
- # Foreign partition IDs (in which the project ID does
- # not match the context project ID ) are discouraged.
- # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
- "projectId": "A String", # The ID of the project to which the entities belong.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- },
- },
- "blobValue": "A String", # A blob value.
- # May have at most 1,000,000 bytes.
- # When `exclude_from_indexes` is false, may have at most 1500 bytes.
- # In JSON requests, must be base64-encoded.
- "stringValue": "A String", # A UTF-8 encoded string value.
- # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
- # Otherwise, may be set to at least 1,000,000 bytes.
- "nullValue": "A String", # A null value.
- "arrayValue": { # An array value. # An array value.
- # Cannot contain another array value.
- # A `Value` instance that sets field `array_value` must not set fields
- # `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array.
- # The order of this array may not be preserved if it contains a mix of
- # indexed and unindexed values.
- # Object with schema name: Value
- ],
- },
- "integerValue": "A String", # An integer value.
- "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
- # of doubles representing degrees latitude and degrees longitude. Unless
- # specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
- #
- # Example of normalization code in Python:
- #
- # def NormalizeLongitude(longitude):
- # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
- # q, r = divmod(longitude, 360.0)
- # if r > 180.0 or (r == 180.0 and q <= -1.0):
- # return r - 360.0
- # return r
- #
- # def NormalizeLatLng(latitude, longitude):
- # """Wraps decimal degrees latitude and longitude to
- # [-180.0, 180.0] and [-90.0, 90.0], respectively."""
- # r = latitude % 360.0
- # if r <= 90.0:
- # return r, NormalizeLongitude(longitude)
- # elif r >= 270.0:
- # return r - 360, NormalizeLongitude(longitude)
- # else:
- # return 180 - r, NormalizeLongitude(longitude + 180.0)
- #
- # assert 180.0 == NormalizeLongitude(180.0)
- # assert -180.0 == NormalizeLongitude(-180.0)
- # assert -179.0 == NormalizeLongitude(181.0)
- # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
- # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
- # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
- # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
- # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
- # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
- # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
- # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
- # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
- # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- },
- },
- ],
- "namedBindings": { # For each non-reserved named binding site in the query string,
- # there must be a named parameter with that name,
- # but not necessarily the inverse.
+ "namedBindings": { # For each non-reserved named binding site in the query string, there must be
+ # a named parameter with that name, but not necessarily the inverse.
+ #
# Key must match regex `A-Za-z_$*`, must not match regex
# `__.*__`, and must not be `""`.
"a_key": { # A binding parameter for a GQL query.
@@ -2191,13 +2067,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -2261,7 +2137,7 @@
#
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
- # [-180.0, 180.0] and [-90.0, 90.0], respectively."""
+ # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
@@ -2289,15 +2165,166 @@
},
},
},
- "allowLiterals": True or False, # When false, the query string must not contain any literals and instead
- # must bind all values. For example,
+ "positionalBindings": [ # Numbered binding site @1 references the first numbered parameter,
+ # effectively using 1-based indexing, rather than the usual 0.
+ #
+ # For each binding site numbered i in `query_string`, there must be an i-th
+ # numbered parameter. The inverse must also be true.
+ { # A binding parameter for a GQL query.
+ "cursor": "A String", # A query cursor. Query cursors are returned in query
+ # result batches.
+ "value": { # A message that can hold any of the supported value types and associated # A value parameter.
+ # metadata.
+ "booleanValue": True or False, # A boolean value.
+ "entityValue": # Object with schema name: Entity # An entity value.
+ #
+ # - May have no key.
+ # - May have a key with an incomplete key path.
+ # - May have a reserved/read-only key.
+ "timestampValue": "A String", # A timestamp value.
+ # When stored in the Datastore, precise only to microseconds;
+ # any additional precision is rounded down.
+ "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined
+ # explicitly.
+ "doubleValue": 3.14, # A double value.
+ "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
+ "keyValue": { # A unique identifier for an entity. # A key value.
+ # If a key's partition ID or any of its path kinds or names are
+ # reserved/read-only, the key is reserved/read-only.
+ # A reserved/read-only key is forbidden in certain documented contexts.
+ "path": [ # The entity path.
+ # An entity path consists of one or more elements composed of a kind and a
+ # string or numerical identifier, which identify entities. The first
+ # element identifies a _root entity_, the second element identifies
+ # a _child_ of the root entity, the third element identifies a child of the
+ # second entity, and so forth. The entities identified by all prefixes of
+ # the path are called the element's _ancestors_.
+ #
+ # An entity path is always fully complete: *all* of the entity's ancestors
+ # are required to be in the path along with the entity identifier itself.
+ # The only exception is that in some documented cases, the identifier in the
+ # last path element (for the entity) itself may be omitted. For example,
+ # the last path element of the key of `Mutation.insert` may have no
+ # identifier.
+ #
+ # A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # If either name or ID is set, the element is complete.
+ # If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity.
+ # A kind matching regex `__.*__` is reserved/read-only.
+ # A kind must not contain more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
+ "name": "A String", # The name of the entity.
+ # A name matching regex `__.*__` is reserved/read-only.
+ # A name must not be more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ },
+ ],
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
+ # ID and namespace ID.
+ # Queries are scoped to a single partition.
+ # by project and namespace, however the namespace ID may be empty.
+ #
+ # A partition ID contains several dimensions:
+ # project ID and namespace ID.
+ #
+ # Partition dimensions:
+ #
+ # - May be `""`.
+ # - Must be valid UTF-8 bytes.
+ # - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
+ # If the value of any dimension matches regex `__.*__`, the partition is
+ # reserved/read-only.
+ # A reserved/read-only partition ID is forbidden in certain documented
+ # contexts.
+ #
+ # Foreign partition IDs (in which the project ID does
+ # not match the context project ID ) are discouraged.
+ # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ },
+ },
+ "blobValue": "A String", # A blob value.
+ # May have at most 1,000,000 bytes.
+ # When `exclude_from_indexes` is false, may have at most 1500 bytes.
+ # In JSON requests, must be base64-encoded.
+ "stringValue": "A String", # A UTF-8 encoded string value.
+ # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
+ # Otherwise, may be set to at least 1,000,000 bytes.
+ "nullValue": "A String", # A null value.
+ "arrayValue": { # An array value. # An array value.
+ # Cannot contain another array value.
+ # A `Value` instance that sets field `array_value` must not set fields
+ # `meaning` or `exclude_from_indexes`.
+ "values": [ # Values in the array.
+ # The order of this array may not be preserved if it contains a mix of
+ # indexed and unindexed values.
+ # Object with schema name: Value
+ ],
+ },
+ "integerValue": "A String", # An integer value.
+ "geoPointValue": { # An object representing a latitude/longitude pair. This is expressed as a pair # A geo point value representing a point on the surface of Earth.
+ # of doubles representing degrees latitude and degrees longitude. Unless
+ # specified otherwise, this must conform to the
+ # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+ # standard</a>. Values must be within normalized ranges.
+ #
+ # Example of normalization code in Python:
+ #
+ # def NormalizeLongitude(longitude):
+ # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
+ # q, r = divmod(longitude, 360.0)
+ # if r > 180.0 or (r == 180.0 and q <= -1.0):
+ # return r - 360.0
+ # return r
+ #
+ # def NormalizeLatLng(latitude, longitude):
+ # """Wraps decimal degrees latitude and longitude to
+ # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
+ # r = latitude % 360.0
+ # if r <= 90.0:
+ # return r, NormalizeLongitude(longitude)
+ # elif r >= 270.0:
+ # return r - 360, NormalizeLongitude(longitude)
+ # else:
+ # return 180 - r, NormalizeLongitude(longitude + 180.0)
+ #
+ # assert 180.0 == NormalizeLongitude(180.0)
+ # assert -180.0 == NormalizeLongitude(-180.0)
+ # assert -179.0 == NormalizeLongitude(181.0)
+ # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
+ # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
+ # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
+ # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
+ # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
+ # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
+ # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
+ # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
+ # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
+ # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
+ },
+ ],
+ "queryString": "A String", # A string of the format described
+ # [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
+ "allowLiterals": True or False, # When false, the query string must not contain any literals and instead must
+ # bind all values. For example,
# `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while
# `SELECT * FROM Kind WHERE a = @value` is.
},
"readOptions": { # The options shared by read requests. # The options for this query.
"transaction": "A String", # The identifier of the transaction in which to read. A
# transaction identifier is returned by a call to
- # BeginTransaction.
+ # Datastore.BeginTransaction.
"readConsistency": "A String", # The non-transactional read consistency to use.
# Cannot be set to `STRONG` for global queries.
},
@@ -2311,7 +2338,7 @@
Returns:
An object of the form:
- { # The response for google.datastore.v1beta3.Datastore.RunQuery.
+ { # The response for Datastore.RunQuery.
"query": { # A query for entities. # The parsed form of the `GqlQuery` from the request, if it was set.
"startCursor": "A String", # A starting point for the query results. Query cursors are
# returned in query result batches and
@@ -2394,13 +2421,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -2464,7 +2491,7 @@
#
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
- # [-180.0, 180.0] and [-90.0, 90.0], respectively."""
+ # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
@@ -2514,11 +2541,28 @@
},
"batch": { # A batch of results produced by a query. # A batch of query results (always present).
"entityResultType": "A String", # The result type for every entity in `entity_results`.
+ "snapshotVersion": "A String", # The version number of the snapshot this batch was returned from.
+ # This applies to the range of results from the query's `start_cursor` (or
+ # the beginning of the query if no cursor was given) to this batch's
+ # `end_cursor` (not the query's `end_cursor`).
+ #
+ # In a single transaction, subsequent query result batches for the same query
+ # can have a greater snapshot version number. Each batch's snapshot version
+ # is valid for all preceding batches.
"skippedResults": 42, # The number of results skipped, typically because of an offset.
"entityResults": [ # The results for this batch.
{ # The result of fetching an entity from Datastore.
"cursor": "A String", # A cursor that points to the position after the result entity.
# Set only when the `EntityResult` is part of a `QueryResultBatch` message.
+ "version": "A String", # The version of the entity, a strictly positive number that monotonically
+ # increases with changes to the entity.
+ #
+ # This field is set for `FULL` entity
+ # results.
+ #
+ # For missing entities in `LookupResponse`, this
+ # is the version of the snapshot that was used to look up the entity, and it
+ # is always set except for eventually consistent reads.
"entity": { # A Datastore data object. # The resulting entity.
#
# An entity is limited to 1 megabyte when stored. That _roughly_
@@ -2573,13 +2617,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
@@ -2643,7 +2687,7 @@
#
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
- # [-180.0, 180.0] and [-90.0, 90.0], respectively."""
+ # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
@@ -2703,13 +2747,13 @@
# A kind matching regex `__.*__` is reserved/read-only.
# A kind must not contain more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
"name": "A String", # The name of the entity.
# A name matching regex `__.*__` is reserved/read-only.
# A name must not be more than 1500 bytes when UTF-8 encoded.
# Cannot be `""`.
- "id": "A String", # The auto-allocated ID of the entity.
- # Never equal to zero. Values less than zero are discouraged and may not
- # be supported in the future.
},
],
"partitionId": { # A partition ID identifies a grouping of entities. The grouping is always # Entities are partitioned into subsets, currently identified by a project
diff --git a/docs/dyn/deploymentmanager_v2beta1.deployments.html b/docs/dyn/deploymentmanager_v2beta1.deployments.html
deleted file mode 100644
index 2dfdbb6..0000000
--- a/docs/dyn/deploymentmanager_v2beta1.deployments.html
+++ /dev/null
@@ -1,273 +0,0 @@
-<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="deploymentmanager_v2beta1.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta1.deployments.html">deployments</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(project, deployment)</a></code></p>
-<p class="firstline">Deletes a deployment and all of the resources in the deployment.</p>
-<p class="toc_element">
- <code><a href="#get">get(project, deployment)</a></code></p>
-<p class="firstline">Gets information about a specific deployment.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates a deployment and all of the resources described by the deployment manifest.</p>
-<p class="toc_element">
- <code><a href="#list">list(project, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Lists all deployments for a given 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, deployment)</code>
- <pre>Deletes a deployment and all of the resources in the deployment.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "name": "A String", # [Output Only] Name of the operation.
- "warnings": [ # [Output Only] If warning messages generated during processing of this operation, this field will be populated.
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "", # 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.
- },
- ],
- },
- ],
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "httpErrorStatusCode": 42, # [Output Only] If operation fails, the HTTP error status code returned, e.g. 404.
- "user": "A String", # [Output Only] User who requested the operation, for example "user@example.com"
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
- "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.
- },
- ],
- },
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "operationType": "A String", # [Output Only] Type of the operation. Examples include "insert", or "delete"
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "httpErrorMessage": "A String", # [Output Only] If operation fails, the HTTP error message returned, e.g. NOT FOUND.
- "progress": 42, # [Output Only] 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.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 format.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the manifest.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(project, deployment)</code>
- <pre>Gets information about a specific deployment.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
-
-Returns:
- An object of the form:
-
- {
- "targetConfig": "A String", # [Input Only] The YAML configuration to use in processing this deployment.
- #
- # When you create a deployment, the server creates a new manifest with the given YAML configuration and sets the `manifest` property to the URL of the manifest resource.
- "manifest": "A String", # [Output Only] URL of the manifest representing the full configuration of this deployment.
- "description": "A String", # An optional user-provided description of the deployment.
- "name": "A String", # The name of the deployment, which must be unique within the project.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(project, body)</code>
- <pre>Creates a deployment and all of the resources described by the deployment manifest.
-
-Args:
- project: string, The project ID for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "targetConfig": "A String", # [Input Only] The YAML configuration to use in processing this deployment.
- #
- # When you create a deployment, the server creates a new manifest with the given YAML configuration and sets the `manifest` property to the URL of the manifest resource.
- "manifest": "A String", # [Output Only] URL of the manifest representing the full configuration of this deployment.
- "description": "A String", # An optional user-provided description of the deployment.
- "name": "A String", # The name of the deployment, which must be unique within the project.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "name": "A String", # [Output Only] Name of the operation.
- "warnings": [ # [Output Only] If warning messages generated during processing of this operation, this field will be populated.
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "", # 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.
- },
- ],
- },
- ],
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "httpErrorStatusCode": 42, # [Output Only] If operation fails, the HTTP error status code returned, e.g. 404.
- "user": "A String", # [Output Only] User who requested the operation, for example "user@example.com"
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
- "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.
- },
- ],
- },
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "operationType": "A String", # [Output Only] Type of the operation. Examples include "insert", or "delete"
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "httpErrorMessage": "A String", # [Output Only] If operation fails, the HTTP error message returned, e.g. NOT FOUND.
- "progress": 42, # [Output Only] 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.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 format.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the manifest.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, pageToken=None, maxResults=None)</code>
- <pre>Lists all deployments for a given project.
-
-Args:
- project: string, The project ID for this request. (required)
- pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
- maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
-
-Returns:
- An object of the form:
-
- { # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # A token used to continue a truncated list request.
- "deployments": [ # The deployments contained in this response.
- {
- "targetConfig": "A String", # [Input Only] The YAML configuration to use in processing this deployment.
- #
- # When you create a deployment, the server creates a new manifest with the given YAML configuration and sets the `manifest` property to the URL of the manifest resource.
- "manifest": "A String", # [Output Only] URL of the manifest representing the full configuration of this deployment.
- "description": "A String", # An optional user-provided description of the deployment.
- "name": "A String", # The name of the deployment, which must be unique within the project.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/deploymentmanager_v2beta1.html b/docs/dyn/deploymentmanager_v2beta1.html
deleted file mode 100644
index 06488b6..0000000
--- a/docs/dyn/deploymentmanager_v2beta1.html
+++ /dev/null
@@ -1,102 +0,0 @@
-<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="deploymentmanager_v2beta1.html">Google Cloud Deployment Manager API V2</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="deploymentmanager_v2beta1.deployments.html">deployments()</a></code>
-</p>
-<p class="firstline">Returns the deployments Resource.</p>
-
-<p class="toc_element">
- <code><a href="deploymentmanager_v2beta1.manifests.html">manifests()</a></code>
-</p>
-<p class="firstline">Returns the manifests Resource.</p>
-
-<p class="toc_element">
- <code><a href="deploymentmanager_v2beta1.operations.html">operations()</a></code>
-</p>
-<p class="firstline">Returns the operations Resource.</p>
-
-<p class="toc_element">
- <code><a href="deploymentmanager_v2beta1.resources.html">resources()</a></code>
-</p>
-<p class="firstline">Returns the resources Resource.</p>
-
-<p class="toc_element">
- <code><a href="deploymentmanager_v2beta1.types.html">types()</a></code>
-</p>
-<p class="firstline">Returns the types Resource.</p>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/deploymentmanager_v2beta1.manifests.html b/docs/dyn/deploymentmanager_v2beta1.manifests.html
deleted file mode 100644
index ba012b6..0000000
--- a/docs/dyn/deploymentmanager_v2beta1.manifests.html
+++ /dev/null
@@ -1,149 +0,0 @@
-<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="deploymentmanager_v2beta1.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta1.manifests.html">manifests</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(project, deployment, manifest)</a></code></p>
-<p class="firstline">Gets information about a specific manifest.</p>
-<p class="toc_element">
- <code><a href="#list">list(project, deployment, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Lists all manifests for a given deployment.</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, deployment, manifest)</code>
- <pre>Gets information about a specific manifest.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
- manifest: string, The name of the manifest for this request. (required)
-
-Returns:
- An object of the form:
-
- {
- "evaluatedConfig": "A String", # [Output Only] The fully-expanded configuration file, including any templates and references.
- "config": "A String", # The YAML configuration for this manifest.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the manifest.
- "name": "A String", # [Output Only] The name of the manifest.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, deployment, pageToken=None, maxResults=None)</code>
- <pre>Lists all manifests for a given deployment.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
- pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
- maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
-
-Returns:
- An object of the form:
-
- { # A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # A token used to continue a truncated list request.
- "manifests": [ # Manifests contained in this list response.
- {
- "evaluatedConfig": "A String", # [Output Only] The fully-expanded configuration file, including any templates and references.
- "config": "A String", # The YAML configuration for this manifest.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the manifest.
- "name": "A String", # [Output Only] The name of the manifest.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/deploymentmanager_v2beta1.operations.html b/docs/dyn/deploymentmanager_v2beta1.operations.html
deleted file mode 100644
index b23ce91..0000000
--- a/docs/dyn/deploymentmanager_v2beta1.operations.html
+++ /dev/null
@@ -1,211 +0,0 @@
-<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="deploymentmanager_v2beta1.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta1.operations.html">operations</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(project, operation)</a></code></p>
-<p class="firstline">Gets information about a specific Operation.</p>
-<p class="toc_element">
- <code><a href="#list">list(project, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Lists all Operations for a 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, operation)</code>
- <pre>Gets information about a specific Operation.
-
-Args:
- project: string, The project ID for this request. (required)
- operation: string, The name of the operation for this request. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "name": "A String", # [Output Only] Name of the operation.
- "warnings": [ # [Output Only] If warning messages generated during processing of this operation, this field will be populated.
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "", # 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.
- },
- ],
- },
- ],
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "httpErrorStatusCode": 42, # [Output Only] If operation fails, the HTTP error status code returned, e.g. 404.
- "user": "A String", # [Output Only] User who requested the operation, for example "user@example.com"
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
- "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.
- },
- ],
- },
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "operationType": "A String", # [Output Only] Type of the operation. Examples include "insert", or "delete"
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "httpErrorMessage": "A String", # [Output Only] If operation fails, the HTTP error message returned, e.g. NOT FOUND.
- "progress": 42, # [Output Only] 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.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 format.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the manifest.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, pageToken=None, maxResults=None)</code>
- <pre>Lists all Operations for a project.
-
-Args:
- project: string, The project ID for this request. (required)
- pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
- maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
-
-Returns:
- An object of the form:
-
- { # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # A token used to continue a truncated list request.
- "operations": [ # Operations contained in this list response.
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
- "name": "A String", # [Output Only] Name of the operation.
- "warnings": [ # [Output Only] If warning messages generated during processing of this operation, this field will be populated.
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "", # 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.
- },
- ],
- },
- ],
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "httpErrorStatusCode": 42, # [Output Only] If operation fails, the HTTP error status code returned, e.g. 404.
- "user": "A String", # [Output Only] User who requested the operation, for example "user@example.com"
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
- "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.
- },
- ],
- },
- "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
- "operationType": "A String", # [Output Only] Type of the operation. Examples include "insert", or "delete"
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
- "httpErrorMessage": "A String", # [Output Only] If operation fails, the HTTP error message returned, e.g. NOT FOUND.
- "progress": 42, # [Output Only] 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.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 format.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the manifest.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/deploymentmanager_v2beta1.resources.html b/docs/dyn/deploymentmanager_v2beta1.resources.html
deleted file mode 100644
index 610a6d8..0000000
--- a/docs/dyn/deploymentmanager_v2beta1.resources.html
+++ /dev/null
@@ -1,159 +0,0 @@
-<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="deploymentmanager_v2beta1.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta1.resources.html">resources</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(project, deployment, resource)</a></code></p>
-<p class="firstline">Gets information about a single resource.</p>
-<p class="toc_element">
- <code><a href="#list">list(project, deployment, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Lists all resources in a given deployment.</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, deployment, resource)</code>
- <pre>Gets information about a single resource.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
- resource: string, The name of the resource for this request. (required)
-
-Returns:
- An object of the form:
-
- {
- "errors": [ # [Output Only] A list of any errors that occurred during deployment.
- "A String",
- ],
- "name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
- "url": "A String", # [Output Only] The URL of the actual resource.
- "manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
- "state": "A String", # [Output Only] The state of the resource.
- "intent": "A String", # [Output Only] The intended state of the resource.
- "type": "A String", # [Output Only] The type of the resource, for example ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, deployment, pageToken=None, maxResults=None)</code>
- <pre>Lists all resources in a given deployment.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
- pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
- maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
-
-Returns:
- An object of the form:
-
- { # A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # A token used to continue a truncated list request.
- "resources": [ # Resources contained in this list response.
- {
- "errors": [ # [Output Only] A list of any errors that occurred during deployment.
- "A String",
- ],
- "name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
- "url": "A String", # [Output Only] The URL of the actual resource.
- "manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
- "state": "A String", # [Output Only] The state of the resource.
- "intent": "A String", # [Output Only] The intended state of the resource.
- "type": "A String", # [Output Only] The type of the resource, for example ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/deploymentmanager_v2beta1.types.html b/docs/dyn/deploymentmanager_v2beta1.types.html
deleted file mode 100644
index d4f6b97..0000000
--- a/docs/dyn/deploymentmanager_v2beta1.types.html
+++ /dev/null
@@ -1,102 +0,0 @@
-<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="deploymentmanager_v2beta1.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta1.types.html">types</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(project, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Lists all Types for Deployment Manager.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(project, pageToken=None, maxResults=None)</code>
- <pre>Lists all Types for Deployment Manager.
-
-Args:
- project: string, The project ID for this request. (required)
- pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
- maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
-
-Returns:
- An object of the form:
-
- { # A response that returns all Types supported by Deployment Manager
- "types": [ # Types supported by Deployment Manager
- { # A type supported by Deployment Manager.
- "name": "A String", # Name of the type.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/deploymentmanager_v2beta2.deployments.html b/docs/dyn/deploymentmanager_v2beta2.deployments.html
deleted file mode 100644
index 59e3a56..0000000
--- a/docs/dyn/deploymentmanager_v2beta2.deployments.html
+++ /dev/null
@@ -1,575 +0,0 @@
-<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="deploymentmanager_v2beta2.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta2.deployments.html">deployments</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(project, deployment)</a></code></p>
-<p class="firstline">Deletes a deployment and all of the resources in the deployment.</p>
-<p class="toc_element">
- <code><a href="#get">get(project, deployment)</a></code></p>
-<p class="firstline">Gets information about a specific deployment.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(project, body)</a></code></p>
-<p class="firstline">Creates a deployment and all of the resources described by the deployment manifest.</p>
-<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists all deployments for a given 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, deployment, body, deletePolicy=None, updatePolicy=None, createPolicy=None)</a></code></p>
-<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(project, deployment, body, deletePolicy=None, updatePolicy=None, createPolicy=None)</a></code></p>
-<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(project, deployment)</code>
- <pre>Deletes a deployment and all of the resources in the deployment.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(project, deployment)</code>
- <pre>Gets information about a specific deployment.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
-
-Returns:
- An object of the form:
-
- {
- "updateTime": "A String", # [Output Only] Timestamp when the deployment was updated, in RFC3339 text format .
- "description": "A String", # An optional user-provided description of the deployment.
- "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
- "errors": [ # [Output Only] List of all errors encountered while trying to enact the update.
- "A String",
- ],
- "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
- },
- "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
- "state": "A String", # [Output Only] The current state of the deployment. This can be DEPLOYED, DEPLOYMENT_FAILED, PREVIEWING, UPDATING, and CANCELING.
- "intent": "A String", # [Input Only] Specifies how Deployment Manager should apply this template. Possible options are PREVIEW, UPDATE, and CANCEL.
- #
- # PREVIEW creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview updates to deployments or preview new deployments. You must provide a target.config with a configuration for this intent. After previewing a deployment, you can deploy your resources by making a request with the UPDATE intent or you can CANCEL the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
- #
- # UPDATE performs an update to the underlying resources in a deployment. If you provide a populated target.config field with this request, Deployment Manager uses that configuration to perform an update. If you had previewed this update beforehand, and do not supply a target.config or provide an empty target.config, Deployment Manager uses the last previewed configuration.
- #
- # CANCEL cancels an update that is in PREVIEW or UPDATE but does not undo any changes already made.
- "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
- "fingerprint": "A String", # Specifies a fingerprint for update() requests. A fingerprint is a randomly generated value that must be provided in update() requests to perform optimistic locking. This ensures optimistic concurrency so that only one update can be performed at a time.
- #
- # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
- "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
- "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
- {
- "content": "A String", # The contents of the file.
- "name": "A String", # The name of the file.
- },
- ],
- "config": "A String", # The configuration to use for this deployment.
- },
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "name": "A String", # The name of the deployment, which must be unique within the project.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(project, body)</code>
- <pre>Creates a deployment and all of the resources described by the deployment manifest.
-
-Args:
- project: string, The project ID for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "updateTime": "A String", # [Output Only] Timestamp when the deployment was updated, in RFC3339 text format .
- "description": "A String", # An optional user-provided description of the deployment.
- "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
- "errors": [ # [Output Only] List of all errors encountered while trying to enact the update.
- "A String",
- ],
- "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
- },
- "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
- "state": "A String", # [Output Only] The current state of the deployment. This can be DEPLOYED, DEPLOYMENT_FAILED, PREVIEWING, UPDATING, and CANCELING.
- "intent": "A String", # [Input Only] Specifies how Deployment Manager should apply this template. Possible options are PREVIEW, UPDATE, and CANCEL.
- #
- # PREVIEW creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview updates to deployments or preview new deployments. You must provide a target.config with a configuration for this intent. After previewing a deployment, you can deploy your resources by making a request with the UPDATE intent or you can CANCEL the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
- #
- # UPDATE performs an update to the underlying resources in a deployment. If you provide a populated target.config field with this request, Deployment Manager uses that configuration to perform an update. If you had previewed this update beforehand, and do not supply a target.config or provide an empty target.config, Deployment Manager uses the last previewed configuration.
- #
- # CANCEL cancels an update that is in PREVIEW or UPDATE but does not undo any changes already made.
- "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
- "fingerprint": "A String", # Specifies a fingerprint for update() requests. A fingerprint is a randomly generated value that must be provided in update() requests to perform optimistic locking. This ensures optimistic concurrency so that only one update can be performed at a time.
- #
- # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
- "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
- "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
- {
- "content": "A String", # The contents of the file.
- "name": "A String", # The name of the file.
- },
- ],
- "config": "A String", # The configuration to use for this deployment.
- },
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "name": "A String", # The name of the deployment, which must be unique within the project.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all deployments for a given project.
-
-Args:
- project: string, The project ID for this request. (required)
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
- filter: string, Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "deployments": [ # [Output Only] The deployments contained in this response.
- {
- "updateTime": "A String", # [Output Only] Timestamp when the deployment was updated, in RFC3339 text format .
- "description": "A String", # An optional user-provided description of the deployment.
- "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
- "errors": [ # [Output Only] List of all errors encountered while trying to enact the update.
- "A String",
- ],
- "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
- },
- "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
- "state": "A String", # [Output Only] The current state of the deployment. This can be DEPLOYED, DEPLOYMENT_FAILED, PREVIEWING, UPDATING, and CANCELING.
- "intent": "A String", # [Input Only] Specifies how Deployment Manager should apply this template. Possible options are PREVIEW, UPDATE, and CANCEL.
- #
- # PREVIEW creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview updates to deployments or preview new deployments. You must provide a target.config with a configuration for this intent. After previewing a deployment, you can deploy your resources by making a request with the UPDATE intent or you can CANCEL the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
- #
- # UPDATE performs an update to the underlying resources in a deployment. If you provide a populated target.config field with this request, Deployment Manager uses that configuration to perform an update. If you had previewed this update beforehand, and do not supply a target.config or provide an empty target.config, Deployment Manager uses the last previewed configuration.
- #
- # CANCEL cancels an update that is in PREVIEW or UPDATE but does not undo any changes already made.
- "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
- "fingerprint": "A String", # Specifies a fingerprint for update() requests. A fingerprint is a randomly generated value that must be provided in update() requests to perform optimistic locking. This ensures optimistic concurrency so that only one update can be performed at a time.
- #
- # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
- "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
- "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
- {
- "content": "A String", # The contents of the file.
- "name": "A String", # The name of the file.
- },
- ],
- "config": "A String", # The configuration to use for this deployment.
- },
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "name": "A String", # The name of the deployment, which must be unique within the project.
- },
- ],
- }</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, deployment, body, deletePolicy=None, updatePolicy=None, createPolicy=None)</code>
- <pre>Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "updateTime": "A String", # [Output Only] Timestamp when the deployment was updated, in RFC3339 text format .
- "description": "A String", # An optional user-provided description of the deployment.
- "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
- "errors": [ # [Output Only] List of all errors encountered while trying to enact the update.
- "A String",
- ],
- "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
- },
- "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
- "state": "A String", # [Output Only] The current state of the deployment. This can be DEPLOYED, DEPLOYMENT_FAILED, PREVIEWING, UPDATING, and CANCELING.
- "intent": "A String", # [Input Only] Specifies how Deployment Manager should apply this template. Possible options are PREVIEW, UPDATE, and CANCEL.
- #
- # PREVIEW creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview updates to deployments or preview new deployments. You must provide a target.config with a configuration for this intent. After previewing a deployment, you can deploy your resources by making a request with the UPDATE intent or you can CANCEL the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
- #
- # UPDATE performs an update to the underlying resources in a deployment. If you provide a populated target.config field with this request, Deployment Manager uses that configuration to perform an update. If you had previewed this update beforehand, and do not supply a target.config or provide an empty target.config, Deployment Manager uses the last previewed configuration.
- #
- # CANCEL cancels an update that is in PREVIEW or UPDATE but does not undo any changes already made.
- "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
- "fingerprint": "A String", # Specifies a fingerprint for update() requests. A fingerprint is a randomly generated value that must be provided in update() requests to perform optimistic locking. This ensures optimistic concurrency so that only one update can be performed at a time.
- #
- # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
- "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
- "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
- {
- "content": "A String", # The contents of the file.
- "name": "A String", # The name of the file.
- },
- ],
- "config": "A String", # The configuration to use for this deployment.
- },
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "name": "A String", # The name of the deployment, which must be unique within the project.
- }
-
- deletePolicy: string, Sets the policy to use for deleting resources.
- Allowed values
- ABANDON -
- DELETE -
- updatePolicy: string, Sets the policy to use for updating resources.
- Allowed values
- PATCH -
- UPDATE -
- createPolicy: string, Sets the policy to use for creating new resources.
- Allowed values
- ACQUIRE -
- CREATE_OR_ACQUIRE -
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(project, deployment, body, deletePolicy=None, updatePolicy=None, createPolicy=None)</code>
- <pre>Updates a deployment and all of the resources described by the deployment manifest.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "updateTime": "A String", # [Output Only] Timestamp when the deployment was updated, in RFC3339 text format .
- "description": "A String", # An optional user-provided description of the deployment.
- "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
- "errors": [ # [Output Only] List of all errors encountered while trying to enact the update.
- "A String",
- ],
- "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
- },
- "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
- "state": "A String", # [Output Only] The current state of the deployment. This can be DEPLOYED, DEPLOYMENT_FAILED, PREVIEWING, UPDATING, and CANCELING.
- "intent": "A String", # [Input Only] Specifies how Deployment Manager should apply this template. Possible options are PREVIEW, UPDATE, and CANCEL.
- #
- # PREVIEW creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview updates to deployments or preview new deployments. You must provide a target.config with a configuration for this intent. After previewing a deployment, you can deploy your resources by making a request with the UPDATE intent or you can CANCEL the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
- #
- # UPDATE performs an update to the underlying resources in a deployment. If you provide a populated target.config field with this request, Deployment Manager uses that configuration to perform an update. If you had previewed this update beforehand, and do not supply a target.config or provide an empty target.config, Deployment Manager uses the last previewed configuration.
- #
- # CANCEL cancels an update that is in PREVIEW or UPDATE but does not undo any changes already made.
- "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
- "fingerprint": "A String", # Specifies a fingerprint for update() requests. A fingerprint is a randomly generated value that must be provided in update() requests to perform optimistic locking. This ensures optimistic concurrency so that only one update can be performed at a time.
- #
- # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
- "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
- "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
- {
- "content": "A String", # The contents of the file.
- "name": "A String", # The name of the file.
- },
- ],
- "config": "A String", # The configuration to use for this deployment.
- },
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "name": "A String", # The name of the deployment, which must be unique within the project.
- }
-
- deletePolicy: string, Sets the policy to use for deleting resources.
- Allowed values
- ABANDON -
- DELETE -
- updatePolicy: string, Sets the policy to use for updating resources.
- Allowed values
- PATCH -
- UPDATE -
- createPolicy: string, Sets the policy to use for creating new resources.
- Allowed values
- ACQUIRE -
- CREATE_OR_ACQUIRE -
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/deploymentmanager_v2beta2.manifests.html b/docs/dyn/deploymentmanager_v2beta2.manifests.html
deleted file mode 100644
index f693dd5..0000000
--- a/docs/dyn/deploymentmanager_v2beta2.manifests.html
+++ /dev/null
@@ -1,166 +0,0 @@
-<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="deploymentmanager_v2beta2.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta2.manifests.html">manifests</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(project, deployment, manifest)</a></code></p>
-<p class="firstline">Gets information about a specific manifest.</p>
-<p class="toc_element">
- <code><a href="#list">list(project, deployment, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists all manifests for a given deployment.</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, deployment, manifest)</code>
- <pre>Gets information about a specific manifest.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
- manifest: string, The name of the manifest for this request. (required)
-
-Returns:
- An object of the form:
-
- {
- "layout": "A String", # [Output Only] The YAML layout for this manifest.
- "name": "A String", # [Output Only] The name of the manifest.
- "imports": [ # [Output Only] The imported files for this manifest.
- {
- "content": "A String", # The contents of the file.
- "name": "A String", # The name of the file.
- },
- ],
- "evaluatedConfig": "A String", # [Output Only] The fully-expanded configuration file, including any templates and references.
- "insertTime": "A String", # [Output Only] Timestamp when the manifest was created, in RFC3339 text format.
- "config": "A String", # [Output Only] The YAML configuration for this manifest.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the manifest.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, deployment, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all manifests for a given deployment.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
- filter: string, Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "manifests": [ # [Output Only] Manifests contained in this list response.
- {
- "layout": "A String", # [Output Only] The YAML layout for this manifest.
- "name": "A String", # [Output Only] The name of the manifest.
- "imports": [ # [Output Only] The imported files for this manifest.
- {
- "content": "A String", # The contents of the file.
- "name": "A String", # The name of the file.
- },
- ],
- "evaluatedConfig": "A String", # [Output Only] The fully-expanded configuration file, including any templates and references.
- "insertTime": "A String", # [Output Only] Timestamp when the manifest was created, in RFC3339 text format.
- "config": "A String", # [Output Only] The YAML configuration for this manifest.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "selfLink": "A String", # [Output Only] Self link for the manifest.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/deploymentmanager_v2beta2.operations.html b/docs/dyn/deploymentmanager_v2beta2.operations.html
deleted file mode 100644
index 546dafc..0000000
--- a/docs/dyn/deploymentmanager_v2beta2.operations.html
+++ /dev/null
@@ -1,220 +0,0 @@
-<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="deploymentmanager_v2beta2.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta2.operations.html">operations</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(project, operation)</a></code></p>
-<p class="firstline">Gets information about a specific operation.</p>
-<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists all operations for a 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, operation)</code>
- <pre>Gets information about a specific operation.
-
-Args:
- project: string, The project ID for this request. (required)
- operation: string, The name of the operation for this request. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all operations for a project.
-
-Args:
- project: string, The project ID for this request. (required)
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
- filter: string, Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
- "operations": [ # [Output Only] Operations contained in this list response.
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "progress": 42, # [Output Only] 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 monotonically increase as the operation progresses.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
- {
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
- {
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- "key": "A String", # [Output Only] A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
- "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this operation.
- {
- "message": "A String", # [Output Only] An optional, human-readable error message.
- "code": "A String", # [Output Only] The error type identifier for this error.
- "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
- "selfLink": "A String", # [Output Only] Server defined URL for the resource.
- "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/deploymentmanager_v2beta2.resources.html b/docs/dyn/deploymentmanager_v2beta2.resources.html
deleted file mode 100644
index e98adf2..0000000
--- a/docs/dyn/deploymentmanager_v2beta2.resources.html
+++ /dev/null
@@ -1,178 +0,0 @@
-<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="deploymentmanager_v2beta2.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta2.resources.html">resources</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(project, deployment, resource)</a></code></p>
-<p class="firstline">Gets information about a single resource.</p>
-<p class="toc_element">
- <code><a href="#list">list(project, deployment, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists all resources in a given deployment.</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, deployment, resource)</code>
- <pre>Gets information about a single resource.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
- resource: string, The name of the resource for this request. (required)
-
-Returns:
- An object of the form:
-
- {
- "finalProperties": "A String", # [Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML.
- "updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
- "name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
- "url": "A String", # [Output Only] The URL of the actual resource.
- "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
- "finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
- "errors": [ # [Output Only] List of all errors encountered while trying to enact update.intent.
- "A String",
- ],
- "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this resource.
- "state": "A String", # [Output Only] The state of the resource.
- "intent": "A String", # [Output Only] The intent of the resource, PREVIEW, UPDATE, or CANCEL.
- "properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
- },
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
- "manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
- "type": "A String", # [Output Only] The type of the resource, for example ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?
- "properties": "A String", # [Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, deployment, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all resources in a given deployment.
-
-Args:
- project: string, The project ID for this request. (required)
- deployment: string, The name of the deployment for this request. (required)
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
- filter: string, Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # A token used to continue a truncated list request.
- "resources": [ # Resources contained in this list response.
- {
- "finalProperties": "A String", # [Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML.
- "updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
- "name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
- "url": "A String", # [Output Only] The URL of the actual resource.
- "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
- "finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
- "errors": [ # [Output Only] List of all errors encountered while trying to enact update.intent.
- "A String",
- ],
- "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this resource.
- "state": "A String", # [Output Only] The state of the resource.
- "intent": "A String", # [Output Only] The intent of the resource, PREVIEW, UPDATE, or CANCEL.
- "properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
- },
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
- "insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
- "manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
- "type": "A String", # [Output Only] The type of the resource, for example ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?
- "properties": "A String", # [Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/deploymentmanager_v2beta2.types.html b/docs/dyn/deploymentmanager_v2beta2.types.html
deleted file mode 100644
index 7613be0..0000000
--- a/docs/dyn/deploymentmanager_v2beta2.types.html
+++ /dev/null
@@ -1,121 +0,0 @@
-<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="deploymentmanager_v2beta2.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta2.types.html">types</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Lists all resource types for Deployment Manager.</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(project, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Lists all resource types for Deployment Manager.
-
-Args:
- project: string, The project ID for this request. (required)
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
- filter: string, Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # A response that returns all Types supported by Deployment Manager
- "nextPageToken": "A String", # A token used to continue a truncated list request.
- "types": [ # [Output Only] A list of resource types supported by Deployment Manager.
- { # A resource type supported by Deployment Manager.
- "name": "A String", # Name of the 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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v1_3.dimensionValues.html b/docs/dyn/dfareporting_v1_3.dimensionValues.html
deleted file mode 100644
index f9ed90f..0000000
--- a/docs/dyn/dfareporting_v1_3.dimensionValues.html
+++ /dev/null
@@ -1,148 +0,0 @@
-<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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v1_3.files.html b/docs/dyn/dfareporting_v1_3.files.html
deleted file mode 100644
index 2b67078..0000000
--- a/docs/dyn/dfareporting_v1_3.files.html
+++ /dev/null
@@ -1,243 +0,0 @@
-<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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v1_3.html b/docs/dyn/dfareporting_v1_3.html
deleted file mode 100644
index 1787adb..0000000
--- a/docs/dyn/dfareporting_v1_3.html
+++ /dev/null
@@ -1,97 +0,0 @@
-<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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v1_3.reports.compatibleFields.html b/docs/dyn/dfareporting_v1_3.reports.compatibleFields.html
deleted file mode 100644
index 3ceb69c..0000000
--- a/docs/dyn/dfareporting_v1_3.reports.compatibleFields.html
+++ /dev/null
@@ -1,763 +0,0 @@
-<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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v1_3.reports.files.html b/docs/dyn/dfareporting_v1_3.reports.files.html
deleted file mode 100644
index 60ba96a..0000000
--- a/docs/dyn/dfareporting_v1_3.reports.files.html
+++ /dev/null
@@ -1,241 +0,0 @@
-<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.files.html">files</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, reportId, fileId)</a></code></p>
-<p class="firstline">Retrieves a report file.</p>
-<p class="toc_element">
- <code><a href="#get_media">get_media(profileId, reportId, fileId)</a></code></p>
-<p class="firstline">Retrieves a report file.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Lists files for a report.</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(profileId, reportId, fileId)</code>
- <pre>Retrieves a report file.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- 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(profileId, reportId, fileId)</code>
- <pre>Retrieves a report file.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- 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, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)</code>
- <pre>Lists files for a report.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the parent report. (required)
- pageToken: string, The value of the nextToken from the previous result page.
- sortField: string, The field by which to sort the list.
- Allowed values
- ID - Sort by file ID.
- LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
- 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.
-
-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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v1_3.reports.html b/docs/dyn/dfareporting_v1_3.reports.html
deleted file mode 100644
index deb2bfa..0000000
--- a/docs/dyn/dfareporting_v1_3.reports.html
+++ /dev/null
@@ -1,4510 +0,0 @@
-<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></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="dfareporting_v1_3.reports.compatibleFields.html">compatibleFields()</a></code>
-</p>
-<p class="firstline">Returns the compatibleFields Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v1_3.reports.files.html">files()</a></code>
-</p>
-<p class="firstline">Returns the files Resource.</p>
-
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, reportId)</a></code></p>
-<p class="firstline">Deletes a report by its ID.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, reportId)</a></code></p>
-<p class="firstline">Retrieves a report by its ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Creates a report.</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">Retrieves list of reports.</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(profileId, reportId, body)</a></code></p>
-<p class="firstline">Updates a report. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#run">run(profileId, reportId, synchronous=None)</a></code></p>
-<p class="firstline">Runs a report.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, reportId, body)</a></code></p>
-<p class="firstline">Updates a report.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, reportId)</code>
- <pre>Deletes a report by its ID.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, reportId)</code>
- <pre>Retrieves a report by its ID.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
-
-Returns:
- An object of the form:
-
- { # 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.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Creates a report.
-
-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 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.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)</code>
- <pre>Retrieves list of reports.
-
-Args:
- profileId: string, The DFA user 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 report ID.
- LAST_MODIFIED_TIME - Sort by 'lastModifiedTime' field.
- NAME - Sort by name of reports.
- scope: string, The scope that defines which results are returned, default is 'MINE'.
- Allowed values
- ALL - All reports in account.
- MINE - My reports.
-
-Returns:
- An object of the form:
-
- { # Represents the list of reports.
- "nextPageToken": "A String", # Continuation token used to page through reports. 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 reports returned in this response.
- { # 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.
- },
- ],
- "kind": "dfareporting#reportList", # The kind of list this is, in this case dfareporting#reportList.
- "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>
-
-<div class="method">
- <code class="details" id="patch">patch(profileId, reportId, body)</code>
- <pre>Updates a report. This method supports patch semantics.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (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 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.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="run">run(profileId, reportId, synchronous=None)</code>
- <pre>Runs a report.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the report. (required)
- synchronous: boolean, If set and true, tries to run the report synchronously.
-
-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="update">update(profileId, reportId, body)</code>
- <pre>Updates a report.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (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 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.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v1_3.userProfiles.html b/docs/dyn/dfareporting_v1_3.userProfiles.html
deleted file mode 100644
index dc0cbc7..0000000
--- a/docs/dyn/dfareporting_v1_3.userProfiles.html
+++ /dev/null
@@ -1,133 +0,0 @@
-<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.userProfiles.html">userProfiles</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId)</a></code></p>
-<p class="firstline">Gets one user profile by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list()</a></code></p>
-<p class="firstline">Retrieves list of user profiles for a user.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId)</code>
- <pre>Gets one user profile by ID.
-
-Args:
- profileId: string, The user profile ID. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a UserProfile resource.
- "userName": "A String", # The user name.
- "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
- "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
- "accountName": "A String", # The account name this profile belongs to.
- "etag": "A String", # The eTag of this response for caching purposes.
- "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
- "profileId": "A String", # The unique ID of the user profile.
- "accountId": "A String", # The account ID to which this profile belongs.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list()</code>
- <pre>Retrieves list of user profiles for a user.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # Represents the list of user profiles.
- "items": [ # The user profiles returned in this response.
- { # Represents a UserProfile resource.
- "userName": "A String", # The user name.
- "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
- "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
- "accountName": "A String", # The account name this profile belongs to.
- "etag": "A String", # The eTag of this response for caching purposes.
- "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
- "profileId": "A String", # The unique ID of the user profile.
- "accountId": "A String", # The account ID to which this profile belongs.
- },
- ],
- "kind": "dfareporting#userProfileList", # The kind of list this is, in this case dfareporting#userProfileList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.accountActiveAdSummaries.html b/docs/dyn/dfareporting_v2_0.accountActiveAdSummaries.html
deleted file mode 100644
index f0297c9..0000000
--- a/docs/dyn/dfareporting_v2_0.accountActiveAdSummaries.html
+++ /dev/null
@@ -1,101 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.accountActiveAdSummaries.html">accountActiveAdSummaries</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, summaryAccountId)</a></code></p>
-<p class="firstline">Gets the account's active ad summary by account ID.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, summaryAccountId)</code>
- <pre>Gets the account's active ad summary by account ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- summaryAccountId: string, Account ID. (required)
-
-Returns:
- An object of the form:
-
- { # Gets a summary of active ads in an account.
- "availableAds": "A String", # Ads that can be activated for the account.
- "kind": "dfareporting#accountActiveAdSummary", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary".
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for the account.
- "activeAds": "A String", # Ads that have been activated for the account
- "accountId": "A String", # ID of the account.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.accountPermissionGroups.html b/docs/dyn/dfareporting_v2_0.accountPermissionGroups.html
deleted file mode 100644
index d6ccf38..0000000
--- a/docs/dyn/dfareporting_v2_0.accountPermissionGroups.html
+++ /dev/null
@@ -1,124 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.accountPermissionGroups.html">accountPermissionGroups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one account permission group by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves the list of account permission groups.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one account permission group by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Account permission group ID. (required)
-
-Returns:
- An object of the form:
-
- { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
- "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
- "id": "A String", # ID of this account permission group.
- "name": "A String", # Name of this account permission group.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves the list of account permission groups.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Account Permission Group List Response
- "kind": "dfareporting#accountPermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse".
- "accountPermissionGroups": [ # Account permission group collection
- { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
- "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
- "id": "A String", # ID of this account permission group.
- "name": "A String", # Name of this account permission group.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.accountPermissions.html b/docs/dyn/dfareporting_v2_0.accountPermissions.html
deleted file mode 100644
index 576c612..0000000
--- a/docs/dyn/dfareporting_v2_0.accountPermissions.html
+++ /dev/null
@@ -1,142 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.accountPermissions.html">accountPermissions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one account permission by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves the list of account permissions.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one account permission by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Account permission ID. (required)
-
-Returns:
- An object of the form:
-
- { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
- "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
- "name": "A String", # Name of this account permission.
- "level": "A String", # Administrative level required to enable this account permission.
- "permissionGroupId": "A String", # Permission group of this account permission.
- "accountProfiles": [ # Account profiles associated with this account permission.
- #
- # Possible values are:
- # - "ACCOUNT_PROFILE_BASIC"
- # - "ACCOUNT_PROFILE_STANDARD"
- "A String",
- ],
- "id": "A String", # ID of this account permission.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves the list of account permissions.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Account Permission List Response
- "accountPermissions": [ # Account permission collection
- { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
- "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
- "name": "A String", # Name of this account permission.
- "level": "A String", # Administrative level required to enable this account permission.
- "permissionGroupId": "A String", # Permission group of this account permission.
- "accountProfiles": [ # Account profiles associated with this account permission.
- #
- # Possible values are:
- # - "ACCOUNT_PROFILE_BASIC"
- # - "ACCOUNT_PROFILE_STANDARD"
- "A String",
- ],
- "id": "A String", # ID of this account permission.
- },
- ],
- "kind": "dfareporting#accountPermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse".
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.accountUserProfiles.html b/docs/dyn/dfareporting_v2_0.accountUserProfiles.html
deleted file mode 100644
index 0cc6ef5..0000000
--- a/docs/dyn/dfareporting_v2_0.accountUserProfiles.html
+++ /dev/null
@@ -1,540 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.accountUserProfiles.html">accountUserProfiles</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one account user profile by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None)</a></code></p>
-<p class="firstline">Retrieves a list of account user profiles, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing account user profile. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing account user profile.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one account user profile by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User profile ID. (required)
-
-Returns:
- An object of the form:
-
- { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None)</code>
- <pre>Retrieves a list of account user profiles, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015" or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015" or simply "user profile".
- subaccountId: string, Select only user profiles with the specified subaccount ID.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only user profiles with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- userRoleId: string, Select only user profiles with the specified user role ID.
- active: boolean, Select only active user profiles.
-
-Returns:
- An object of the form:
-
- { # Account User Profile List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "accountUserProfiles": [ # Account user profile collection
- { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- },
- ],
- "kind": "dfareporting#accountUserProfilesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".
- }</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(profileId, id, body)</code>
- <pre>Updates an existing account user profile. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User profile ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing account user profile.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.ads.html b/docs/dyn/dfareporting_v2_0.ads.html
deleted file mode 100644
index 9c5c8f3..0000000
--- a/docs/dyn/dfareporting_v2_0.ads.html
+++ /dev/null
@@ -1,2727 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.ads.html">ads</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one ad by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new ad.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None)</a></code></p>
-<p class="firstline">Retrieves a list of ads, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing ad. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing ad.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one ad by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Ad ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after first dot on the left) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a connection type that can be targeted by ads.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new ad.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after first dot on the left) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a connection type that can be targeted by ads.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after first dot on the left) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a connection type that can be targeted by ads.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None)</code>
- <pre>Retrieves a list of ads, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- landingPageIds: string, Select only ads with these landing page IDs. (repeated)
- overriddenEventTagId: string, Select only ads with this event tag override ID.
- campaignIds: string, Select only ads with these campaign IDs. (repeated)
- sizeIds: string, Select only ads with these size IDs. (repeated)
- archived: boolean, Select only archived ads.
- creativeOptimizationConfigurationIds: string, Select only ads with these creative optimization configuration IDs. (repeated)
- sslCompliant: boolean, Select only ads that are SSL-compliant.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- type: string, Select only ads with these types. (repeated)
- Allowed values
- AD_SERVING_CLICK_TRACKER -
- AD_SERVING_DEFAULT_AD -
- AD_SERVING_STANDARD_AD -
- AD_SERVING_TRACKING -
- sslRequired: boolean, Select only ads that require SSL.
- creativeIds: string, Select only ads with these creative IDs assigned. (repeated)
- remarketingListIds: string, Select only ads whose list targeting expression use these remarketing list IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- creativeType: string, Select only ads with the specified creativeType.
- Allowed values
- BRAND_SAFE_DEFAULT_INSTREAM_VIDEO -
- CUSTOM_INPAGE -
- CUSTOM_INTERSTITIAL -
- ENHANCED_BANNER -
- ENHANCED_IMAGE -
- FLASH_INPAGE -
- HTML5_BANNER -
- IMAGE -
- INSTREAM_VIDEO -
- INTERNAL_REDIRECT -
- INTERSTITIAL_INTERNAL_REDIRECT -
- REDIRECT -
- RICH_MEDIA_EXPANDING -
- RICH_MEDIA_IM_EXPAND -
- RICH_MEDIA_INPAGE -
- RICH_MEDIA_INPAGE_FLOATING -
- RICH_MEDIA_INTERSTITIAL_FLOAT -
- RICH_MEDIA_MOBILE_IN_APP -
- RICH_MEDIA_MULTI_FLOATING -
- RICH_MEDIA_PEEL_DOWN -
- TRACKING_TEXT -
- VPAID_LINEAR -
- VPAID_NON_LINEAR -
- placementIds: string, Select only ads with these placement IDs assigned. (repeated)
- active: boolean, Select only active ads.
- compatibility: string, Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- Allowed values
- APP -
- APP_INTERSTITIAL -
- IN_STREAM_VIDEO -
- WEB -
- WEB_INTERSTITIAL -
- advertiserId: string, Select only ads with this advertiser ID.
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015" or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015" or simply "ad".
- audienceSegmentIds: string, Select only ads with these audience segment IDs. (repeated)
- ids: string, Select only ads with these IDs. (repeated)
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- dynamicClickTracker: boolean, Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.
-
-Returns:
- An object of the form:
-
- { # Ad List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#adsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse".
- "ads": [ # Ad collection
- { # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after first dot on the left) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a connection type that can be targeted by ads.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing ad. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Ad ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after first dot on the left) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a connection type that can be targeted by ads.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after first dot on the left) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a connection type that can be targeted by ads.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing ad.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after first dot on the left) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a connection type that can be targeted by ads.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after first dot on the left) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a connection type that can be targeted by ads.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.advertiserGroups.html b/docs/dyn/dfareporting_v2_0.advertiserGroups.html
deleted file mode 100644
index 612146a..0000000
--- a/docs/dyn/dfareporting_v2_0.advertiserGroups.html
+++ /dev/null
@@ -1,263 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.advertiserGroups.html">advertiserGroups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing advertiser group.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one advertiser group by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new advertiser group.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of advertiser groups, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing advertiser group. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing advertiser group.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing advertiser group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Advertiser group ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one advertiser group by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Advertiser group ID. (required)
-
-Returns:
- An object of the form:
-
- { # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new advertiser group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Retrieves a list of advertiser groups, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015" or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015" or simply "advertisergroup".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only advertiser groups with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Advertiser Group List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#advertiserGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".
- "advertiserGroups": [ # Advertiser group collection
- { # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing advertiser group. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Advertiser group ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing advertiser group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.advertisers.html b/docs/dyn/dfareporting_v2_0.advertisers.html
deleted file mode 100644
index 835d407..0000000
--- a/docs/dyn/dfareporting_v2_0.advertisers.html
+++ /dev/null
@@ -1,459 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.advertisers.html">advertisers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one advertiser by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new advertiser.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None)</a></code></p>
-<p class="firstline">Retrieves a list of advertisers, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing advertiser. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing advertiser.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one advertiser by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Advertiser ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new advertiser.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None)</code>
- <pre>Retrieves a list of advertisers, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- includeAdvertisersWithoutGroupsOnly: boolean, Select only advertisers which do not belong to any advertiser group.
- onlyParent: boolean, Select only advertisers which use another advertiser's floodlight configuration.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- status: string, Select only advertisers with the specified status.
- Allowed values
- APPROVED -
- ON_HOLD -
- maxResults: integer, Maximum number of results to return.
- advertiserGroupIds: string, Select only advertisers with these advertiser group IDs. (repeated)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015" or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015" or simply "advertiser".
- subaccountId: string, Select only advertisers with these subaccount IDs.
- ids: string, Select only advertisers with these IDs. (repeated)
- floodlightConfigurationIds: string, Select only advertisers with these floodlight configuration IDs. (repeated)
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
-
-Returns:
- An object of the form:
-
- { # Advertiser List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "advertisers": [ # Advertiser collection
- { # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- },
- ],
- "kind": "dfareporting#advertisersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".
- }</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(profileId, id, body)</code>
- <pre>Updates an existing advertiser. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Advertiser ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing advertiser.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.browsers.html b/docs/dyn/dfareporting_v2_0.browsers.html
deleted file mode 100644
index 51260ca..0000000
--- a/docs/dyn/dfareporting_v2_0.browsers.html
+++ /dev/null
@@ -1,106 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.browsers.html">browsers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of browsers.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of browsers.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Browser List Response
- "kind": "dfareporting#browsersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse".
- "browsers": [ # Browser collection
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.campaigns.html b/docs/dyn/dfareporting_v2_0.campaigns.html
deleted file mode 100644
index 62b770f..0000000
--- a/docs/dyn/dfareporting_v2_0.campaigns.html
+++ /dev/null
@@ -1,1139 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.campaigns.html">campaigns</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one campaign by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body)</a></code></p>
-<p class="firstline">Inserts a new campaign.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None)</a></code></p>
-<p class="firstline">Retrieves a list of campaigns, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing campaign. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing campaign.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one campaign by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Campaign ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body)</code>
- <pre>Inserts a new campaign.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- defaultLandingPageName: string, Default landing page name for this new campaign. Must be less than 256 characters long. (required)
- defaultLandingPageUrl: string, Default landing page URL for this new campaign. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None)</code>
- <pre>Retrieves a list of campaigns, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- overriddenEventTagId: string, Select only campaigns that have overridden this event tag ID.
- archived: boolean, Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
- advertiserIds: string, Select only campaigns that belong to these advertisers. (repeated)
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- maxResults: integer, Maximum number of results to return.
- excludedIds: string, Exclude campaigns with these IDs. (repeated)
- advertiserGroupIds: string, Select only campaigns whose advertisers belong to these advertiser groups. (repeated)
- searchString: string, Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015" or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015" or simply "campaign".
- subaccountId: string, Select only campaigns that belong to this subaccount.
- ids: string, Select only campaigns with these IDs. (repeated)
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- atLeastOneOptimizationActivity: boolean, Select only campaigns that have at least one optimization activity.
-
-Returns:
- An object of the form:
-
- { # Campaign List Response
- "campaigns": [ # Campaign collection
- { # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- },
- ],
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#campaignsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".
- }</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(profileId, id, body)</code>
- <pre>Updates an existing campaign. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Campaign ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing campaign.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.changeLogs.html b/docs/dyn/dfareporting_v2_0.changeLogs.html
deleted file mode 100644
index d05b8e0..0000000
--- a/docs/dyn/dfareporting_v2_0.changeLogs.html
+++ /dev/null
@@ -1,228 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.changeLogs.html">changeLogs</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one change log by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None)</a></code></p>
-<p class="firstline">Retrieves a list of change logs.</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(profileId, id)</code>
- <pre>Gets one change log by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Change log ID. (required)
-
-Returns:
- An object of the form:
-
- { # Describes a change that a user has made to a resource.
- "changeTime": "A String", # Time when the object was modified.
- "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
- "subaccountId": "A String", # Subaccount ID of the modified object.
- "userProfileId": "A String", # ID of the user who modified the object.
- "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
- "newValue": "A String", # New value of the object field.
- "userProfileName": "A String", # User profile name of the user who modified the object.
- "fieldName": "A String", # Field name of the object which changed.
- "oldValue": "A String", # Old value of the object field.
- "action": "A String", # Action which caused the change.
- "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
- "objectType": "A String", # Object type of the change log.
- "id": "A String", # ID of this change log.
- "accountId": "A String", # Account ID of the modified object.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None)</code>
- <pre>Retrieves a list of change logs.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- objectType: string, Select only change logs with the specified object type.
- Allowed values
- OBJECT_ACCOUNT -
- OBJECT_ACCOUNT_BILLING_FEATURE -
- OBJECT_AD -
- OBJECT_ADVERTISER -
- OBJECT_ADVERTISER_GROUP -
- OBJECT_BILLING_ACCOUNT_GROUP -
- OBJECT_BILLING_FEATURE -
- OBJECT_BILLING_MINIMUM_FEE -
- OBJECT_BILLING_PROFILE -
- OBJECT_CAMPAIGN -
- OBJECT_CONTENT_CATEGORY -
- OBJECT_CREATIVE -
- OBJECT_CREATIVE_ASSET -
- OBJECT_CREATIVE_BUNDLE -
- OBJECT_CREATIVE_FIELD -
- OBJECT_CREATIVE_GROUP -
- OBJECT_DFA_SITE -
- OBJECT_EVENT_TAG -
- OBJECT_FLOODLIGHT_ACTIVITY_GROUP -
- OBJECT_FLOODLIGHT_ACTVITY -
- OBJECT_FLOODLIGHT_CONFIGURATION -
- OBJECT_INSTREAM_CREATIVE -
- OBJECT_LANDING_PAGE -
- OBJECT_MEDIA_ORDER -
- OBJECT_PLACEMENT -
- OBJECT_PLACEMENT_STRATEGY -
- OBJECT_PROVIDED_LIST_CLIENT -
- OBJECT_RATE_CARD -
- OBJECT_REMARKETING_LIST -
- OBJECT_RICHMEDIA_CREATIVE -
- OBJECT_SD_SITE -
- OBJECT_SIZE -
- OBJECT_SUBACCOUNT -
- OBJECT_USER_PROFILE -
- OBJECT_USER_PROFILE_FILTER -
- OBJECT_USER_ROLE -
- maxChangeTime: string, Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
- pageToken: string, Value of the nextPageToken from the previous result page.
- maxResults: integer, Maximum number of results to return.
- action: string, Select only change logs with the specified action.
- Allowed values
- ACTION_ADD -
- ACTION_ASSIGN -
- ACTION_ASSOCIATE -
- ACTION_CREATE -
- ACTION_DELETE -
- ACTION_DISABLE -
- ACTION_EMAIL_TAGS -
- ACTION_ENABLE -
- ACTION_LINK -
- ACTION_MARK_AS_DEFAULT -
- ACTION_PUSH -
- ACTION_REMOVE -
- ACTION_SEND -
- ACTION_UNASSIGN -
- ACTION_UNLINK -
- ACTION_UPDATE -
- minChangeTime: string, Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
- searchString: string, Select only change logs whose object ID, user name, old or new values match the search string.
- userProfileIds: string, Select only change logs with these user profile IDs. (repeated)
- ids: string, Select only change logs with these IDs. (repeated)
- objectIds: string, Select only change logs with these object IDs. (repeated)
-
-Returns:
- An object of the form:
-
- { # Change Log List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#changeLogsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse".
- "changeLogs": [ # Change log collection
- { # Describes a change that a user has made to a resource.
- "changeTime": "A String", # Time when the object was modified.
- "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
- "subaccountId": "A String", # Subaccount ID of the modified object.
- "userProfileId": "A String", # ID of the user who modified the object.
- "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
- "newValue": "A String", # New value of the object field.
- "userProfileName": "A String", # User profile name of the user who modified the object.
- "fieldName": "A String", # Field name of the object which changed.
- "oldValue": "A String", # Old value of the object field.
- "action": "A String", # Action which caused the change.
- "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
- "objectType": "A String", # Object type of the change log.
- "id": "A String", # ID of this change log.
- "accountId": "A String", # Account ID of the modified object.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.cities.html b/docs/dyn/dfareporting_v2_0.cities.html
deleted file mode 100644
index 1fb2832..0000000
--- a/docs/dyn/dfareporting_v2_0.cities.html
+++ /dev/null
@@ -1,113 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.cities.html">cities</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None)</a></code></p>
-<p class="firstline">Retrieves a list of cities, possibly filtered.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None)</code>
- <pre>Retrieves a list of cities, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- dartIds: string, Select only cities with these DART IDs. (repeated)
- namePrefix: string, Select only cities with names starting with this prefix.
- regionDartIds: string, Select only cities from these regions. (repeated)
- countryDartIds: string, Select only cities from these countries. (repeated)
-
-Returns:
- An object of the form:
-
- { # City List Response
- "kind": "dfareporting#citiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".
- "cities": [ # City collection
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.connectionTypes.html b/docs/dyn/dfareporting_v2_0.connectionTypes.html
deleted file mode 100644
index 5f7e477..0000000
--- a/docs/dyn/dfareporting_v2_0.connectionTypes.html
+++ /dev/null
@@ -1,103 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.connectionTypes.html">connectionTypes</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of connection types.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of connection types.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Connection Type List Response
- "kind": "dfareporting#connectionTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse".
- "connectionTypes": [ # Connection Type Collection.
- { # Contains information about a connection type that can be targeted by ads.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.contentCategories.html b/docs/dyn/dfareporting_v2_0.contentCategories.html
deleted file mode 100644
index 6c0a764..0000000
--- a/docs/dyn/dfareporting_v2_0.contentCategories.html
+++ /dev/null
@@ -1,271 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.contentCategories.html">contentCategories</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing content category.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one content category by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new content category.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of content categories, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing content category. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing content category.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing content category.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Content category ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one content category by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Content category ID. (required)
-
-Returns:
- An object of the form:
-
- { # Organizes placements according to the contents of their associated webpages.
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "description": "A String", # Description of this content category.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new content category.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Organizes placements according to the contents of their associated webpages.
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "description": "A String", # Description of this content category.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Organizes placements according to the contents of their associated webpages.
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "description": "A String", # Description of this content category.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Retrieves a list of content categories, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015" or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015" or simply "contentcategory".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only content categories with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Content Category List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#contentCategoriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse".
- "contentCategories": [ # Content category collection
- { # Organizes placements according to the contents of their associated webpages.
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "description": "A String", # Description of this content category.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing content category. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Content category ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Organizes placements according to the contents of their associated webpages.
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "description": "A String", # Description of this content category.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Organizes placements according to the contents of their associated webpages.
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "description": "A String", # Description of this content category.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing content category.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Organizes placements according to the contents of their associated webpages.
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "description": "A String", # Description of this content category.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Organizes placements according to the contents of their associated webpages.
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "description": "A String", # Description of this content category.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.countries.html b/docs/dyn/dfareporting_v2_0.countries.html
deleted file mode 100644
index 2b55179..0000000
--- a/docs/dyn/dfareporting_v2_0.countries.html
+++ /dev/null
@@ -1,128 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.countries.html">countries</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, dartId)</a></code></p>
-<p class="firstline">Gets one country by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of countries.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, dartId)</code>
- <pre>Gets one country by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- dartId: string, Country DART ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of countries.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Country List Response
- "kind": "dfareporting#countriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse".
- "countries": [ # Country collection
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.creativeFieldValues.html b/docs/dyn/dfareporting_v2_0.creativeFieldValues.html
deleted file mode 100644
index f260e30..0000000
--- a/docs/dyn/dfareporting_v2_0.creativeFieldValues.html
+++ /dev/null
@@ -1,261 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.creativeFieldValues.html">creativeFieldValues</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, creativeFieldId, id)</a></code></p>
-<p class="firstline">Deletes an existing creative field value.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, creativeFieldId, id)</a></code></p>
-<p class="firstline">Gets one creative field value by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, creativeFieldId, body)</a></code></p>
-<p class="firstline">Inserts a new creative field value.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of creative field values, possibly filtered.</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(profileId, creativeFieldId, id, body)</a></code></p>
-<p class="firstline">Updates an existing creative field value. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, creativeFieldId, body)</a></code></p>
-<p class="firstline">Updates an existing creative field value.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, creativeFieldId, id)</code>
- <pre>Deletes an existing creative field value.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- creativeFieldId: string, Creative field ID for this creative field value. (required)
- id: string, Creative Field Value ID (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, creativeFieldId, id)</code>
- <pre>Gets one creative field value by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- creativeFieldId: string, Creative field ID for this creative field value. (required)
- id: string, Creative Field Value ID (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, creativeFieldId, body)</code>
- <pre>Inserts a new creative field value.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- creativeFieldId: string, Creative field ID for this creative field value. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None)</code>
- <pre>Retrieves a list of creative field values, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- creativeFieldId: string, Creative field ID for this creative field value. (required)
- searchString: string, Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- VALUE -
- ids: string, Select only creative field values with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Creative Field Value List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#creativeFieldValuesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse".
- "creativeFieldValues": [ # Creative field value collection
- { # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- },
- ],
- }</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(profileId, creativeFieldId, id, body)</code>
- <pre>Updates an existing creative field value. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- creativeFieldId: string, Creative field ID for this creative field value. (required)
- id: string, Creative Field Value ID (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, creativeFieldId, body)</code>
- <pre>Updates an existing creative field value.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- creativeFieldId: string, Creative field ID for this creative field value. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.creativeFields.html b/docs/dyn/dfareporting_v2_0.creativeFields.html
deleted file mode 100644
index 7ece063..0000000
--- a/docs/dyn/dfareporting_v2_0.creativeFields.html
+++ /dev/null
@@ -1,344 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.creativeFields.html">creativeFields</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing creative field.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one creative field by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new creative field.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of creative fields, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing creative field. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing creative field.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing creative field.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative Field ID (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one creative field by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative Field ID (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new creative field.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Retrieves a list of creative fields, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015" or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015" or simply "creativefield".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- advertiserIds: string, Select only creative fields that belong to these advertisers. (repeated)
- ids: string, Select only creative fields with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Creative Field List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "creativeFields": [ # Creative field collection
- { # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- },
- ],
- "kind": "dfareporting#creativeFieldsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse".
- }</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(profileId, id, body)</code>
- <pre>Updates an existing creative field. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative Field ID (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing creative field.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.creativeGroups.html b/docs/dyn/dfareporting_v2_0.creativeGroups.html
deleted file mode 100644
index d57f10f..0000000
--- a/docs/dyn/dfareporting_v2_0.creativeGroups.html
+++ /dev/null
@@ -1,364 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.creativeGroups.html">creativeGroups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one creative group by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new creative group.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of creative groups, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing creative group. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing creative group.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one creative group by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative group ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new creative group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None)</code>
- <pre>Retrieves a list of creative groups, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015" or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015" or simply "creativegroup".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- advertiserIds: string, Select only creative groups that belong to these advertisers. (repeated)
- groupNumber: integer, Select only creative groups that belong to this subgroup.
- maxResults: integer, Maximum number of results to return.
- ids: string, Select only creative groups with these IDs. (repeated)
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Creative Group List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "creativeGroups": [ # Creative group collection
- { # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- },
- ],
- "kind": "dfareporting#creativeGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse".
- }</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(profileId, id, body)</code>
- <pre>Updates an existing creative group. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative group ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing creative group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.creatives.html b/docs/dyn/dfareporting_v2_0.creatives.html
deleted file mode 100644
index dd21ce8..0000000
--- a/docs/dyn/dfareporting_v2_0.creatives.html
+++ /dev/null
@@ -1,2868 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.creatives.html">creatives</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one creative by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new creative.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None)</a></code></p>
-<p class="firstline">Retrieves a list of creatives, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing creative. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing creative.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one creative by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new creative.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None)</code>
- <pre>Retrieves a list of creatives, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Select only creatives with this campaign ID.
- advertiserId: string, Select only creatives with this advertiser ID.
- sizeIds: string, Select only creatives with these size IDs. (repeated)
- archived: boolean, Select only archived creatives. Leave blank to select archived and unarchived creatives.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- renderingIds: string, Select only creatives with these rendering IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- active: boolean, Select only active creatives. Leave blank to select active and inactive creatives.
- companionCreativeIds: string, Select only in-stream video creatives with these companion IDs. (repeated)
- types: string, Select only creatives with these creative types. (repeated)
- Allowed values
- BRAND_SAFE_DEFAULT_INSTREAM_VIDEO -
- CUSTOM_INPAGE -
- CUSTOM_INTERSTITIAL -
- ENHANCED_BANNER -
- ENHANCED_IMAGE -
- FLASH_INPAGE -
- HTML5_BANNER -
- IMAGE -
- INSTREAM_VIDEO -
- INTERNAL_REDIRECT -
- INTERSTITIAL_INTERNAL_REDIRECT -
- REDIRECT -
- RICH_MEDIA_EXPANDING -
- RICH_MEDIA_IM_EXPAND -
- RICH_MEDIA_INPAGE -
- RICH_MEDIA_INPAGE_FLOATING -
- RICH_MEDIA_INTERSTITIAL_FLOAT -
- RICH_MEDIA_MOBILE_IN_APP -
- RICH_MEDIA_MULTI_FLOATING -
- RICH_MEDIA_PEEL_DOWN -
- TRACKING_TEXT -
- VPAID_LINEAR -
- VPAID_NON_LINEAR -
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015" or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015" or simply "creative".
- ids: string, Select only creatives with these IDs. (repeated)
- studioCreativeId: string, Select only creatives corresponding to this Studio creative ID.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- creativeFieldIds: string, Select only creatives with these creative field IDs. (repeated)
-
-Returns:
- An object of the form:
-
- { # Creative List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#creativesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".
- "creatives": [ # Creative collection
- { # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing creative. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing creative.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.dimensionValues.html b/docs/dyn/dfareporting_v2_0.dimensionValues.html
deleted file mode 100644
index 00e680b..0000000
--- a/docs/dyn/dfareporting_v2_0.dimensionValues.html
+++ /dev/null
@@ -1,144 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.directorySiteContacts.html b/docs/dyn/dfareporting_v2_0.directorySiteContacts.html
deleted file mode 100644
index 3375768..0000000
--- a/docs/dyn/dfareporting_v2_0.directorySiteContacts.html
+++ /dev/null
@@ -1,163 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.directorySiteContacts.html">directorySiteContacts</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one directory site contact by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of directory site contacts, possibly filtered.</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(profileId, id)</code>
- <pre>Gets one directory site contact by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Directory site contact ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Site Directory contact.
- "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
- "firstName": "A String", # First name of this directory site contact.
- "lastName": "A String", # Last name of this directory site contact.
- "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
- "role": "A String", # Directory site contact role.
- "type": "A String", # Directory site contact type.
- "email": "A String", # Email address of this directory site contact.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Retrieves a list of directory site contacts, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015" or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015" or simply "directory site contact".
- directorySiteIds: string, Select only directory site contacts with these directory site IDs. This is a required field. (repeated)
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only directory site contacts with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Directory Site Contact List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "directorySiteContacts": [ # Directory site contact collection
- { # Contains properties of a Site Directory contact.
- "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
- "firstName": "A String", # First name of this directory site contact.
- "lastName": "A String", # Last name of this directory site contact.
- "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
- "role": "A String", # Directory site contact role.
- "type": "A String", # Directory site contact type.
- "email": "A String", # Email address of this directory site contact.
- },
- ],
- "kind": "dfareporting#directorySiteContactsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse".
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.directorySites.html b/docs/dyn/dfareporting_v2_0.directorySites.html
deleted file mode 100644
index ce0cc6e..0000000
--- a/docs/dyn/dfareporting_v2_0.directorySites.html
+++ /dev/null
@@ -1,339 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.directorySites.html">directorySites</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one directory site by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None)</a></code></p>
-<p class="firstline">Retrieves a list of directory sites, possibly filtered.</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(profileId, id)</code>
- <pre>Gets one directory site by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Directory site ID. (required)
-
-Returns:
- An object of the form:
-
- { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
- "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
- "countryId": "A String", # Country ID of this directory site.
- "description": "A String", # Description of this directory site.
- "settings": { # Directory Site Settings # Directory site settings.
- "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
- "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
- "dfp_settings": { # DFP Settings # Directory site DFP settings.
- "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal.
- "dfp_network_name": "A String", # DFP network name for this directory site.
- "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
- "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
- "dfp_network_code": "A String", # DFP network code for this directory site.
- },
- "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification tags.
- "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
- "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
- "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
- },
- "currencyId": "A String", # Currency ID of this directory site.
- # Possible values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "inpageTagFormats": [ # Tag types for regular placements.
- #
- # Acceptable values are:
- # - "STANDARD"
- # - "IFRAME_JAVASCRIPT_INPAGE"
- # - "INTERNAL_REDIRECT_INPAGE"
- # - "JAVASCRIPT_INPAGE"
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "interstitialTagFormats": [ # Tag types for interstitial placements.
- #
- # Acceptable values are:
- # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
- # - "INTERNAL_REDIRECT_INTERSTITIAL"
- # - "JAVASCRIPT_INTERSTITIAL"
- "A String",
- ],
- "contactAssignments": [ # Directory site contacts.
- { # Directory Site Contact Assignment
- "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
- "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
- },
- ],
- "url": "A String", # URL of this directory site.
- "parentId": "A String", # Parent directory site ID.
- "active": True or False, # Whether this directory site is active.
- "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
- "name": "A String", # Name of this directory site.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None)</code>
- <pre>Retrieves a list of directory sites, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- countryId: string, Select only directory sites with this country ID.
- acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- parentId: string, Select only directory sites with this parent ID.
- acceptsPublisherPaidPlacements: boolean, Select only directory sites that accept publisher paid placements. This field can be left blank.
- acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
- maxResults: integer, Maximum number of results to return.
- active: boolean, Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
- searchString: string, Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015" or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply "directory site".
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only directory sites with these IDs. (repeated)
- dfp_network_code: string, Select only directory sites with this DFP network code.
-
-Returns:
- An object of the form:
-
- { # Directory Site List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#directorySitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse".
- "directorySites": [ # Directory site collection
- { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
- "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
- "countryId": "A String", # Country ID of this directory site.
- "description": "A String", # Description of this directory site.
- "settings": { # Directory Site Settings # Directory site settings.
- "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
- "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
- "dfp_settings": { # DFP Settings # Directory site DFP settings.
- "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal.
- "dfp_network_name": "A String", # DFP network name for this directory site.
- "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
- "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
- "dfp_network_code": "A String", # DFP network code for this directory site.
- },
- "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification tags.
- "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
- "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
- "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
- },
- "currencyId": "A String", # Currency ID of this directory site.
- # Possible values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "inpageTagFormats": [ # Tag types for regular placements.
- #
- # Acceptable values are:
- # - "STANDARD"
- # - "IFRAME_JAVASCRIPT_INPAGE"
- # - "INTERNAL_REDIRECT_INPAGE"
- # - "JAVASCRIPT_INPAGE"
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "interstitialTagFormats": [ # Tag types for interstitial placements.
- #
- # Acceptable values are:
- # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
- # - "INTERNAL_REDIRECT_INTERSTITIAL"
- # - "JAVASCRIPT_INTERSTITIAL"
- "A String",
- ],
- "contactAssignments": [ # Directory site contacts.
- { # Directory Site Contact Assignment
- "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
- "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
- },
- ],
- "url": "A String", # URL of this directory site.
- "parentId": "A String", # Parent directory site ID.
- "active": True or False, # Whether this directory site is active.
- "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
- "name": "A String", # Name of this directory site.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.eventTags.html b/docs/dyn/dfareporting_v2_0.eventTags.html
deleted file mode 100644
index 627d0fe..0000000
--- a/docs/dyn/dfareporting_v2_0.eventTags.html
+++ /dev/null
@@ -1,485 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.eventTags.html">eventTags</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing event tag.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one event tag by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new event tag.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None)</a></code></p>
-<p class="firstline">Retrieves a list of event tags, possibly filtered.</p>
-<p class="toc_element">
- <code><a href="#patch">patch(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing event tag. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing event tag.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing event tag.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Event tag ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one event tag by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Event tag ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new event tag.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None)</code>
- <pre>Retrieves a list of event tags, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Select only event tags that belong to this campaign.
- advertiserId: string, Select only event tags that belong to this advertiser.
- adId: string, Select only event tags that belong to this ad.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- definitionsOnly: boolean, Examine only the specified ad or campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign is examined as well. In addition, when set to false, the status field is examined as well along with the enabledByDefault field.
- eventTagTypes: string, Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. (repeated)
- Allowed values
- CLICK_THROUGH_EVENT_TAG -
- IMPRESSION_IMAGE_EVENT_TAG -
- IMPRESSION_JAVASCRIPT_EVENT_TAG -
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015" or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015" or simply "eventtag".
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- enabled: boolean, Select only enabled event tags. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.
- ids: string, Select only event tags with these IDs. (repeated)
-
-Returns:
- An object of the form:
-
- { # Event Tag List Response
- "eventTags": [ # Event tag collection
- { # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- },
- ],
- "kind": "dfareporting#eventTagsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse".
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(profileId, id, body)</code>
- <pre>Updates an existing event tag. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Event tag ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing event tag.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.floodlightActivityGroups.html b/docs/dyn/dfareporting_v2_0.floodlightActivityGroups.html
deleted file mode 100644
index 1a2a0c6..0000000
--- a/docs/dyn/dfareporting_v2_0.floodlightActivityGroups.html
+++ /dev/null
@@ -1,501 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.floodlightActivityGroups.html">floodlightActivityGroups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing floodlight activity group.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one floodlight activity group by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new floodlight activity group.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None)</a></code></p>
-<p class="firstline">Retrieves a list of floodlight activity groups, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing floodlight activity group. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing floodlight activity group.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing floodlight activity group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity Group ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one floodlight activity group by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity Group ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new floodlight activity group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None)</code>
- <pre>Retrieves a list of floodlight activity groups, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- advertiserId: string, Select only floodlight activity groups with the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015" or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015" or simply "floodlightactivitygroup".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- floodlightConfigurationId: string, Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
- ids: string, Select only floodlight activity groups with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- type: string, Select only floodlight activity groups with the specified floodlight activity group type.
- Allowed values
- COUNTER -
- SALE -
-
-Returns:
- An object of the form:
-
- { # Floodlight Activity Group List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#floodlightActivityGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse".
- "floodlightActivityGroups": [ # Floodlight activity group collection
- { # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing floodlight activity group. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity Group ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing floodlight activity group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.floodlightConfigurations.html b/docs/dyn/dfareporting_v2_0.floodlightConfigurations.html
deleted file mode 100644
index cb0f19a..0000000
--- a/docs/dyn/dfareporting_v2_0.floodlightConfigurations.html
+++ /dev/null
@@ -1,478 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.floodlightConfigurations.html">floodlightConfigurations</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one floodlight configuration by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, ids=None)</a></code></p>
-<p class="firstline">Retrieves a list of floodlight configurations, possibly filtered.</p>
-<p class="toc_element">
- <code><a href="#patch">patch(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing floodlight configuration. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing floodlight configuration.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one floodlight configuration by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight configuration ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight configuration.
- "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
- "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
- "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
- "imageTagEnabled": True or False, # Whether image tags are enabled.
- },
- "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
- "standardVariableTypes": [ # List of standard variables enabled for this configuration.
- #
- # Acceptable values are:
- # - "ORD"
- # - "NUM"
- "A String",
- ],
- "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
- "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
- "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
- },
- "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
- "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
- "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
- "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, ids=None)</code>
- <pre>Retrieves a list of floodlight configurations, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- ids: string, Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. (repeated)
-
-Returns:
- An object of the form:
-
- { # Floodlight Configuration List Response
- "floodlightConfigurations": [ # Floodlight configuration collection
- { # Contains properties of a Floodlight configuration.
- "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
- "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
- "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
- "imageTagEnabled": True or False, # Whether image tags are enabled.
- },
- "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
- "standardVariableTypes": [ # List of standard variables enabled for this configuration.
- #
- # Acceptable values are:
- # - "ORD"
- # - "NUM"
- "A String",
- ],
- "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
- "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
- "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
- },
- "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
- "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
- "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
- "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
- },
- ],
- "kind": "dfareporting#floodlightConfigurationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse".
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(profileId, id, body)</code>
- <pre>Updates an existing floodlight configuration. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight configuration ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight configuration.
- "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
- "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
- "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
- "imageTagEnabled": True or False, # Whether image tags are enabled.
- },
- "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
- "standardVariableTypes": [ # List of standard variables enabled for this configuration.
- #
- # Acceptable values are:
- # - "ORD"
- # - "NUM"
- "A String",
- ],
- "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
- "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
- "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
- },
- "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
- "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
- "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
- "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight configuration.
- "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
- "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
- "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
- "imageTagEnabled": True or False, # Whether image tags are enabled.
- },
- "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
- "standardVariableTypes": [ # List of standard variables enabled for this configuration.
- #
- # Acceptable values are:
- # - "ORD"
- # - "NUM"
- "A String",
- ],
- "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
- "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
- "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
- },
- "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
- "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
- "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
- "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing floodlight configuration.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight configuration.
- "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
- "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
- "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
- "imageTagEnabled": True or False, # Whether image tags are enabled.
- },
- "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
- "standardVariableTypes": [ # List of standard variables enabled for this configuration.
- #
- # Acceptable values are:
- # - "ORD"
- # - "NUM"
- "A String",
- ],
- "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
- "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
- "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
- },
- "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
- "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
- "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
- "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight configuration.
- "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
- "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
- "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
- "imageTagEnabled": True or False, # Whether image tags are enabled.
- },
- "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
- "standardVariableTypes": [ # List of standard variables enabled for this configuration.
- #
- # Acceptable values are:
- # - "ORD"
- # - "NUM"
- "A String",
- ],
- "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
- "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
- "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
- },
- "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
- "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
- "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
- "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.html b/docs/dyn/dfareporting_v2_0.html
deleted file mode 100644
index 9189918..0000000
--- a/docs/dyn/dfareporting_v2_0.html
+++ /dev/null
@@ -1,317 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.accountActiveAdSummaries.html">accountActiveAdSummaries()</a></code>
-</p>
-<p class="firstline">Returns the accountActiveAdSummaries Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.accountPermissionGroups.html">accountPermissionGroups()</a></code>
-</p>
-<p class="firstline">Returns the accountPermissionGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.accountPermissions.html">accountPermissions()</a></code>
-</p>
-<p class="firstline">Returns the accountPermissions Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.accountUserProfiles.html">accountUserProfiles()</a></code>
-</p>
-<p class="firstline">Returns the accountUserProfiles Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.accounts.html">accounts()</a></code>
-</p>
-<p class="firstline">Returns the accounts Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.ads.html">ads()</a></code>
-</p>
-<p class="firstline">Returns the ads Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.advertiserGroups.html">advertiserGroups()</a></code>
-</p>
-<p class="firstline">Returns the advertiserGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.advertisers.html">advertisers()</a></code>
-</p>
-<p class="firstline">Returns the advertisers Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.browsers.html">browsers()</a></code>
-</p>
-<p class="firstline">Returns the browsers Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.campaignCreativeAssociations.html">campaignCreativeAssociations()</a></code>
-</p>
-<p class="firstline">Returns the campaignCreativeAssociations Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.campaigns.html">campaigns()</a></code>
-</p>
-<p class="firstline">Returns the campaigns Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.changeLogs.html">changeLogs()</a></code>
-</p>
-<p class="firstline">Returns the changeLogs Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.cities.html">cities()</a></code>
-</p>
-<p class="firstline">Returns the cities Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.connectionTypes.html">connectionTypes()</a></code>
-</p>
-<p class="firstline">Returns the connectionTypes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.contentCategories.html">contentCategories()</a></code>
-</p>
-<p class="firstline">Returns the contentCategories Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.countries.html">countries()</a></code>
-</p>
-<p class="firstline">Returns the countries Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.creativeAssets.html">creativeAssets()</a></code>
-</p>
-<p class="firstline">Returns the creativeAssets Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.creativeFieldValues.html">creativeFieldValues()</a></code>
-</p>
-<p class="firstline">Returns the creativeFieldValues Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.creativeFields.html">creativeFields()</a></code>
-</p>
-<p class="firstline">Returns the creativeFields Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.creativeGroups.html">creativeGroups()</a></code>
-</p>
-<p class="firstline">Returns the creativeGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.creatives.html">creatives()</a></code>
-</p>
-<p class="firstline">Returns the creatives Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.dimensionValues.html">dimensionValues()</a></code>
-</p>
-<p class="firstline">Returns the dimensionValues Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.directorySiteContacts.html">directorySiteContacts()</a></code>
-</p>
-<p class="firstline">Returns the directorySiteContacts Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.directorySites.html">directorySites()</a></code>
-</p>
-<p class="firstline">Returns the directorySites Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.eventTags.html">eventTags()</a></code>
-</p>
-<p class="firstline">Returns the eventTags Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.files.html">files()</a></code>
-</p>
-<p class="firstline">Returns the files Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.floodlightActivities.html">floodlightActivities()</a></code>
-</p>
-<p class="firstline">Returns the floodlightActivities Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.floodlightActivityGroups.html">floodlightActivityGroups()</a></code>
-</p>
-<p class="firstline">Returns the floodlightActivityGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.floodlightConfigurations.html">floodlightConfigurations()</a></code>
-</p>
-<p class="firstline">Returns the floodlightConfigurations Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.landingPages.html">landingPages()</a></code>
-</p>
-<p class="firstline">Returns the landingPages Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.metros.html">metros()</a></code>
-</p>
-<p class="firstline">Returns the metros Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.mobileCarriers.html">mobileCarriers()</a></code>
-</p>
-<p class="firstline">Returns the mobileCarriers Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.operatingSystemVersions.html">operatingSystemVersions()</a></code>
-</p>
-<p class="firstline">Returns the operatingSystemVersions Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.operatingSystems.html">operatingSystems()</a></code>
-</p>
-<p class="firstline">Returns the operatingSystems Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.placementGroups.html">placementGroups()</a></code>
-</p>
-<p class="firstline">Returns the placementGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.placementStrategies.html">placementStrategies()</a></code>
-</p>
-<p class="firstline">Returns the placementStrategies Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.placements.html">placements()</a></code>
-</p>
-<p class="firstline">Returns the placements Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.platformTypes.html">platformTypes()</a></code>
-</p>
-<p class="firstline">Returns the platformTypes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.postalCodes.html">postalCodes()</a></code>
-</p>
-<p class="firstline">Returns the postalCodes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.regions.html">regions()</a></code>
-</p>
-<p class="firstline">Returns the regions Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.reports.html">reports()</a></code>
-</p>
-<p class="firstline">Returns the reports Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.sites.html">sites()</a></code>
-</p>
-<p class="firstline">Returns the sites Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.sizes.html">sizes()</a></code>
-</p>
-<p class="firstline">Returns the sizes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.subaccounts.html">subaccounts()</a></code>
-</p>
-<p class="firstline">Returns the subaccounts Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.userProfiles.html">userProfiles()</a></code>
-</p>
-<p class="firstline">Returns the userProfiles Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.userRolePermissionGroups.html">userRolePermissionGroups()</a></code>
-</p>
-<p class="firstline">Returns the userRolePermissionGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.userRolePermissions.html">userRolePermissions()</a></code>
-</p>
-<p class="firstline">Returns the userRolePermissions Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_0.userRoles.html">userRoles()</a></code>
-</p>
-<p class="firstline">Returns the userRoles Resource.</p>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.landingPages.html b/docs/dyn/dfareporting_v2_0.landingPages.html
deleted file mode 100644
index 2e2cc47..0000000
--- a/docs/dyn/dfareporting_v2_0.landingPages.html
+++ /dev/null
@@ -1,247 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.landingPages.html">landingPages</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, campaignId, id)</a></code></p>
-<p class="firstline">Deletes an existing campaign landing page.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, campaignId, id)</a></code></p>
-<p class="firstline">Gets one campaign landing page by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, campaignId, body)</a></code></p>
-<p class="firstline">Inserts a new landing page for the specified campaign.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, campaignId)</a></code></p>
-<p class="firstline">Retrieves the list of landing pages for the specified campaign.</p>
-<p class="toc_element">
- <code><a href="#patch">patch(profileId, campaignId, id, body)</a></code></p>
-<p class="firstline">Updates an existing campaign landing page. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, campaignId, body)</a></code></p>
-<p class="firstline">Updates an existing campaign landing page.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, campaignId, id)</code>
- <pre>Deletes an existing campaign landing page.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Landing page campaign ID. (required)
- id: string, Landing page ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, campaignId, id)</code>
- <pre>Gets one campaign landing page by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Landing page campaign ID. (required)
- id: string, Landing page ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. Must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, campaignId, body)</code>
- <pre>Inserts a new landing page for the specified campaign.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Landing page campaign ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. Must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. Must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, campaignId)</code>
- <pre>Retrieves the list of landing pages for the specified campaign.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Landing page campaign ID. (required)
-
-Returns:
- An object of the form:
-
- { # Landing Page List Response
- "kind": "dfareporting#landingPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPagesListResponse".
- "landingPages": [ # Landing page collection
- { # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. Must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(profileId, campaignId, id, body)</code>
- <pre>Updates an existing campaign landing page. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Landing page campaign ID. (required)
- id: string, Landing page ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. Must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. Must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, campaignId, body)</code>
- <pre>Updates an existing campaign landing page.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Landing page campaign ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. Must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. Must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.metros.html b/docs/dyn/dfareporting_v2_0.metros.html
deleted file mode 100644
index 07b0735..0000000
--- a/docs/dyn/dfareporting_v2_0.metros.html
+++ /dev/null
@@ -1,107 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.metros.html">metros</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of metros.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of metros.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Metro List Response
- "kind": "dfareporting#metrosListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse".
- "metros": [ # Metro collection
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.mobileCarriers.html b/docs/dyn/dfareporting_v2_0.mobileCarriers.html
deleted file mode 100644
index 5000458..0000000
--- a/docs/dyn/dfareporting_v2_0.mobileCarriers.html
+++ /dev/null
@@ -1,105 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.mobileCarriers.html">mobileCarriers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of mobile carriers.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of mobile carriers.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Mobile Carrier List Response
- "kind": "dfareporting#mobileCarriersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse".
- "mobileCarriers": [ # Mobile carrier collection
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.operatingSystemVersions.html b/docs/dyn/dfareporting_v2_0.operatingSystemVersions.html
deleted file mode 100644
index a36e3a1..0000000
--- a/docs/dyn/dfareporting_v2_0.operatingSystemVersions.html
+++ /dev/null
@@ -1,112 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.operatingSystemVersions.html">operatingSystemVersions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of operating system versions.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of operating system versions.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Operating System Version List Response
- "kind": "dfareporting#operatingSystemVersionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse".
- "operatingSystemVersions": [ # Operating system version collection
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after first dot on the left) of this operating system version.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.operatingSystems.html b/docs/dyn/dfareporting_v2_0.operatingSystems.html
deleted file mode 100644
index e11a18f..0000000
--- a/docs/dyn/dfareporting_v2_0.operatingSystems.html
+++ /dev/null
@@ -1,105 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.operatingSystems.html">operatingSystems</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of operating systems.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of operating systems.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Operating System List Response
- "kind": "dfareporting#operatingSystemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse".
- "operatingSystems": [ # Operating system collection
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.placementGroups.html b/docs/dyn/dfareporting_v2_0.placementGroups.html
deleted file mode 100644
index b3d2bf6..0000000
--- a/docs/dyn/dfareporting_v2_0.placementGroups.html
+++ /dev/null
@@ -1,1068 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.placementGroups.html">placementGroups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one placement group by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new placement group.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, sortOrder=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, searchString=None, directorySiteIds=None, ids=None, sortField=None)</a></code></p>
-<p class="firstline">Retrieves a list of placement groups, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing placement group. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing placement group.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one placement group by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement group ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new placement group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, sortOrder=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, searchString=None, directorySiteIds=None, ids=None, sortField=None)</code>
- <pre>Retrieves a list of placement groups, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- siteIds: string, Select only placement groups that are associated with these sites. (repeated)
- placementGroupType: string, Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.
- Allowed values
- PLACEMENT_PACKAGE -
- PLACEMENT_ROADBLOCK -
- pricingTypes: string, Select only placement groups with these pricing types. (repeated)
- Allowed values
- PRICING_TYPE_CPA -
- PRICING_TYPE_CPC -
- PRICING_TYPE_CPM -
- PRICING_TYPE_FLAT_RATE_CLICKS -
- PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
- campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
- advertiserIds: string, Select only placement groups that belong to these advertisers. (repeated)
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- placementStrategyIds: string, Select only placement groups that are associated with these placement strategies. (repeated)
- contentCategoryIds: string, Select only placement groups that are associated with these content categories. (repeated)
- archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
- maxResults: integer, Maximum number of results to return.
- searchString: string, Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015" or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015" or simply "placementgroup".
- directorySiteIds: string, Select only placement groups that are associated with these directory sites. (repeated)
- ids: string, Select only placement groups with these IDs. (repeated)
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
-
-Returns:
- An object of the form:
-
- { # Placement Group List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#placementGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse".
- "placementGroups": [ # Placement group collection
- { # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing placement group. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement group ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing placement group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.placementStrategies.html b/docs/dyn/dfareporting_v2_0.placementStrategies.html
deleted file mode 100644
index e9a7a6e..0000000
--- a/docs/dyn/dfareporting_v2_0.placementStrategies.html
+++ /dev/null
@@ -1,263 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.placementStrategies.html">placementStrategies</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing placement strategy.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one placement strategy by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new placement strategy.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of placement strategies, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing placement strategy. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing placement strategy.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing placement strategy.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement strategy ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one placement strategy by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement strategy ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. Must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new placement strategy.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. Must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. Must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Retrieves a list of placement strategies, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015" or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015" or simply "placementstrategy".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only placement strategies with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Placement Strategy List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#placementStrategiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse".
- "placementStrategies": [ # Placement strategy collection
- { # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. Must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing placement strategy. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement strategy ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. Must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. Must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing placement strategy.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. Must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. Must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.placements.html b/docs/dyn/dfareporting_v2_0.placements.html
deleted file mode 100644
index 83c060c..0000000
--- a/docs/dyn/dfareporting_v2_0.placements.html
+++ /dev/null
@@ -1,1350 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.placements.html">placements</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#generatetags">generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None)</a></code></p>
-<p class="firstline">Generates tags for a placement.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one placement by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new placement.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, sizeIds=None, advertiserIds=None, pageToken=None, sortOrder=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, compatibilities=None, searchString=None, directorySiteIds=None, ids=None, groupIds=None, sortField=None)</a></code></p>
-<p class="firstline">Retrieves a list of placements, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing placement. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing placement.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="generatetags">generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None)</code>
- <pre>Generates tags for a placement.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Generate placements belonging to this campaign. This is a required field.
- tagFormats: string, Tag formats to generate for these placements. (repeated)
- Allowed values
- PLACEMENT_TAG_CLICK_COMMANDS -
- PLACEMENT_TAG_IFRAME_ILAYER -
- PLACEMENT_TAG_IFRAME_JAVASCRIPT -
- PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH -
- PLACEMENT_TAG_INTERNAL_REDIRECT -
- PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT -
- PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT -
- PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT -
- PLACEMENT_TAG_JAVASCRIPT -
- PLACEMENT_TAG_STANDARD -
- PLACEMENT_TAG_TRACKING -
- PLACEMENT_TAG_TRACKING_IFRAME -
- PLACEMENT_TAG_TRACKING_JAVASCRIPT -
- placementIds: string, Generate tags for these placements. (repeated)
-
-Returns:
- An object of the form:
-
- { # Placement GenerateTags Response
- "kind": "dfareporting#placementsGenerateTagsResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse".
- "placementTags": [ # Set of generated tags for the specified placements.
- { # Placement Tag
- "tagDatas": [ # Tags generated for this placement.
- { # Placement Tag Data
- "clickTag": "A String", # Tag string to record a click.
- "impressionTag": "A String", # Tag string for serving an ad.
- "creativeId": "A String", # Creative associated with this placement tag.
- "adId": "A String", # Ad associated with this placement tag.
- "format": "A String", # TagData tag format of this tag.
- },
- ],
- "placementId": "A String", # Placement ID
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one placement by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new placement.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, sizeIds=None, advertiserIds=None, pageToken=None, sortOrder=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, compatibilities=None, searchString=None, directorySiteIds=None, ids=None, groupIds=None, sortField=None)</code>
- <pre>Retrieves a list of placements, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- siteIds: string, Select only placements that are associated with these sites. (repeated)
- paymentSource: string, Select only placements with this payment source.
- Allowed values
- PLACEMENT_AGENCY_PAID -
- PLACEMENT_PUBLISHER_PAID -
- pricingTypes: string, Select only placements with these pricing types. (repeated)
- Allowed values
- PRICING_TYPE_CPA -
- PRICING_TYPE_CPC -
- PRICING_TYPE_CPM -
- PRICING_TYPE_FLAT_RATE_CLICKS -
- PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
- campaignIds: string, Select only placements that belong to these campaigns. (repeated)
- sizeIds: string, Select only placements that are associated with these sizes. (repeated)
- advertiserIds: string, Select only placements that belong to these advertisers. (repeated)
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated)
- contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated)
- archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
- maxResults: integer, Maximum number of results to return.
- compatibilities: string, Select only placements that are associated with these compatibilities. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. (repeated)
- Allowed values
- APP -
- APP_INTERSTITIAL -
- IN_STREAM_VIDEO -
- WEB -
- WEB_INTERSTITIAL -
- searchString: string, Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015" or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015" or simply "placement".
- directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated)
- ids: string, Select only placements with these IDs. (repeated)
- groupIds: string, Select only placements that belong to these placement groups. (repeated)
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
-
-Returns:
- An object of the form:
-
- { # Placement List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#placementsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse".
- "placements": [ # Placement collection
- { # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing placement. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing placement.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date cannot be earlier than the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than or be the same day as the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date cannot be earlier than the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than or be the same day as the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.platformTypes.html b/docs/dyn/dfareporting_v2_0.platformTypes.html
deleted file mode 100644
index a400a7e..0000000
--- a/docs/dyn/dfareporting_v2_0.platformTypes.html
+++ /dev/null
@@ -1,103 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.platformTypes.html">platformTypes</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of platform types.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of platform types.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Platform Type List Response
- "kind": "dfareporting#platformTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse".
- "platformTypes": [ # Platform type collection
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.postalCodes.html b/docs/dyn/dfareporting_v2_0.postalCodes.html
deleted file mode 100644
index bff4968..0000000
--- a/docs/dyn/dfareporting_v2_0.postalCodes.html
+++ /dev/null
@@ -1,104 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.postalCodes.html">postalCodes</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of postal codes.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of postal codes.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Postal Code List Response
- "kind": "dfareporting#postalCodesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse".
- "postalCodes": [ # Postal code collection
- { # Contains information about a postal code that can be targeted by ads.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.regions.html b/docs/dyn/dfareporting_v2_0.regions.html
deleted file mode 100644
index 8597624..0000000
--- a/docs/dyn/dfareporting_v2_0.regions.html
+++ /dev/null
@@ -1,106 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.regions.html">regions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of regions.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of regions.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Region List Response
- "regions": [ # Region Collection.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "kind": "dfareporting#regionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse".
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.reports.compatibleFields.html b/docs/dyn/dfareporting_v2_0.reports.compatibleFields.html
deleted file mode 100644
index e5c9e88..0000000
--- a/docs/dyn/dfareporting_v2_0.reports.compatibleFields.html
+++ /dev/null
@@ -1,551 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.reports.html">reports</a> . <a href="dfareporting_v2_0.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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.sites.html b/docs/dyn/dfareporting_v2_0.sites.html
deleted file mode 100644
index 76fff0e..0000000
--- a/docs/dyn/dfareporting_v2_0.sites.html
+++ /dev/null
@@ -1,643 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.sites.html">sites</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one site by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new site.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None)</a></code></p>
-<p class="firstline">Retrieves a list of sites, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing site. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing site.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one site by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Site ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- "lastName": "A String", # Last name of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "firstName": "A String", # First name of this site contact.
- "contactType": "A String", # Site contact type.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new site.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- "lastName": "A String", # Last name of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "firstName": "A String", # First name of this site contact.
- "contactType": "A String", # Site contact type.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- "lastName": "A String", # Last name of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "firstName": "A String", # First name of this site contact.
- "contactType": "A String", # Site contact type.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None)</code>
- <pre>Retrieves a list of sites, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- unmappedSite: boolean, Select only sites that have not been mapped to a directory site.
- campaignIds: string, Select only sites with these campaign IDs. (repeated)
- acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
- pageToken: string, Value of the nextPageToken from the previous result page.
- acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
- maxResults: integer, Maximum number of results to return.
- adWordsSite: boolean, Select only AdWords sites.
- approved: boolean, Select only approved sites.
- searchString: string, Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015" or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015" or simply "site".
- subaccountId: string, Select only sites with this subaccount ID.
- directorySiteIds: string, Select only sites with these directory site IDs. (repeated)
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only sites with these IDs. (repeated)
-
-Returns:
- An object of the form:
-
- { # Site List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#sitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
- "sites": [ # Site collection
- { # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- "lastName": "A String", # Last name of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "firstName": "A String", # First name of this site contact.
- "contactType": "A String", # Site contact type.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing site. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Site ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- "lastName": "A String", # Last name of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "firstName": "A String", # First name of this site contact.
- "contactType": "A String", # Site contact type.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- "lastName": "A String", # Last name of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "firstName": "A String", # First name of this site contact.
- "contactType": "A String", # Site contact type.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing site.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- "lastName": "A String", # Last name of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "firstName": "A String", # First name of this site contact.
- "contactType": "A String", # Site contact type.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- "lastName": "A String", # Last name of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "firstName": "A String", # First name of this site contact.
- "contactType": "A String", # Site contact type.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.sizes.html b/docs/dyn/dfareporting_v2_0.sizes.html
deleted file mode 100644
index d470ac9..0000000
--- a/docs/dyn/dfareporting_v2_0.sizes.html
+++ /dev/null
@@ -1,165 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.sizes.html">sizes</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one size by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new size.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, iabStandard=None, width=None, ids=None, height=None)</a></code></p>
-<p class="firstline">Retrieves a list of sizes, possibly filtered.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one size by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Size ID. (required)
-
-Returns:
- An object of the form:
-
- { # Represents the dimensions of ads, placements, creatives, or creative assets.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new size.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents the dimensions of ads, placements, creatives, or creative assets.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
-}
-
-
-Returns:
- An object of the form:
-
- { # Represents the dimensions of ads, placements, creatives, or creative assets.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, iabStandard=None, width=None, ids=None, height=None)</code>
- <pre>Retrieves a list of sizes, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- iabStandard: boolean, Select only IAB standard sizes.
- width: integer, Select only sizes with this width.
- ids: string, Select only sizes with these IDs. (repeated)
- height: integer, Select only sizes with this height.
-
-Returns:
- An object of the form:
-
- { # Size List Response
- "kind": "dfareporting#sizesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse".
- "sizes": [ # Size collection
- { # Represents the dimensions of ads, placements, creatives, or creative assets.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.subaccounts.html b/docs/dyn/dfareporting_v2_0.subaccounts.html
deleted file mode 100644
index 7555d0f..0000000
--- a/docs/dyn/dfareporting_v2_0.subaccounts.html
+++ /dev/null
@@ -1,274 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.subaccounts.html">subaccounts</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one subaccount by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new subaccount.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Gets a list of subaccounts, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing subaccount. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing subaccount.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one subaccount by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Subaccount ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new subaccount.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Gets a list of subaccounts, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015" or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015" or simply "subaccount".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only subaccounts with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Subaccount List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#subaccountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse".
- "subaccounts": [ # Subaccount collection
- { # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing subaccount. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Subaccount ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing subaccount.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.userProfiles.html b/docs/dyn/dfareporting_v2_0.userProfiles.html
deleted file mode 100644
index de93b47..0000000
--- a/docs/dyn/dfareporting_v2_0.userProfiles.html
+++ /dev/null
@@ -1,133 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.userProfiles.html">userProfiles</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId)</a></code></p>
-<p class="firstline">Gets one user profile by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list()</a></code></p>
-<p class="firstline">Retrieves list of user profiles for a user.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId)</code>
- <pre>Gets one user profile by ID.
-
-Args:
- profileId: string, The user profile ID. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a UserProfile resource.
- "userName": "A String", # The user name.
- "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
- "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
- "accountName": "A String", # The account name this profile belongs to.
- "etag": "A String", # The eTag of this response for caching purposes.
- "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
- "profileId": "A String", # The unique ID of the user profile.
- "accountId": "A String", # The account ID to which this profile belongs.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list()</code>
- <pre>Retrieves list of user profiles for a user.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # Represents the list of user profiles.
- "items": [ # The user profiles returned in this response.
- { # Represents a UserProfile resource.
- "userName": "A String", # The user name.
- "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
- "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
- "accountName": "A String", # The account name this profile belongs to.
- "etag": "A String", # The eTag of this response for caching purposes.
- "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
- "profileId": "A String", # The unique ID of the user profile.
- "accountId": "A String", # The account ID to which this profile belongs.
- },
- ],
- "kind": "dfareporting#userProfileList", # The kind of list this is, in this case dfareporting#userProfileList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.userRolePermissionGroups.html b/docs/dyn/dfareporting_v2_0.userRolePermissionGroups.html
deleted file mode 100644
index 03814e9..0000000
--- a/docs/dyn/dfareporting_v2_0.userRolePermissionGroups.html
+++ /dev/null
@@ -1,124 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.userRolePermissionGroups.html">userRolePermissionGroups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one user role permission group by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Gets a list of all supported user role permission groups.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one user role permission group by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User role permission group ID. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a grouping of related user role permissions.
- "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
- "id": "A String", # ID of this user role permission.
- "name": "A String", # Name of this user role permission group.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Gets a list of all supported user role permission groups.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # User Role Permission Group List Response
- "userRolePermissionGroups": [ # User role permission group collection
- { # Represents a grouping of related user role permissions.
- "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
- "id": "A String", # ID of this user role permission.
- "name": "A String", # Name of this user role permission group.
- },
- ],
- "kind": "dfareporting#userRolePermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse".
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.userRolePermissions.html b/docs/dyn/dfareporting_v2_0.userRolePermissions.html
deleted file mode 100644
index 21294c0..0000000
--- a/docs/dyn/dfareporting_v2_0.userRolePermissions.html
+++ /dev/null
@@ -1,129 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.userRolePermissions.html">userRolePermissions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one user role permission by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, ids=None)</a></code></p>
-<p class="firstline">Gets a list of user role permissions, possibly filtered.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one user role permission by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User role permission ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, ids=None)</code>
- <pre>Gets a list of user role permissions, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- ids: string, Select only user role permissions with these IDs. (repeated)
-
-Returns:
- An object of the form:
-
- { # User Role Permission List Response
- "userRolePermissions": [ # User role permission collection
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "kind": "dfareporting#userRolePermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse".
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_0.userRoles.html b/docs/dyn/dfareporting_v2_0.userRoles.html
deleted file mode 100644
index a551e09..0000000
--- a/docs/dyn/dfareporting_v2_0.userRoles.html
+++ /dev/null
@@ -1,361 +0,0 @@
-<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_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.userRoles.html">userRoles</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing user role.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one user role by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new user role.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None)</a></code></p>
-<p class="firstline">Retrieves a list of user roles, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing user role. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing user role.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing user role.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User role ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one user role by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User role ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new user role.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None)</code>
- <pre>Retrieves a list of user roles, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015" or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015" or simply "userrole".
- subaccountId: string, Select only user roles that belong to this subaccount.
- pageToken: string, Value of the nextPageToken from the previous result page.
- ids: string, Select only user roles with the specified IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- accountUserRoleOnly: boolean, Select only account level user roles not associated with any specific subaccount.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
-
-Returns:
- An object of the form:
-
- { # User Role List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#userRolesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse".
- "userRoles": [ # User role collection
- { # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing user role. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User role ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing user role.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.accountPermissions.html b/docs/dyn/dfareporting_v2_1.accountPermissions.html
deleted file mode 100644
index 3023d49..0000000
--- a/docs/dyn/dfareporting_v2_1.accountPermissions.html
+++ /dev/null
@@ -1,142 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.accountPermissions.html">accountPermissions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one account permission by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves the list of account permissions.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one account permission by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Account permission ID. (required)
-
-Returns:
- An object of the form:
-
- { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
- "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
- "name": "A String", # Name of this account permission.
- "level": "A String", # Administrative level required to enable this account permission.
- "permissionGroupId": "A String", # Permission group of this account permission.
- "accountProfiles": [ # Account profiles associated with this account permission.
- #
- # Possible values are:
- # - "ACCOUNT_PROFILE_BASIC"
- # - "ACCOUNT_PROFILE_STANDARD"
- "A String",
- ],
- "id": "A String", # ID of this account permission.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves the list of account permissions.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Account Permission List Response
- "accountPermissions": [ # Account permission collection.
- { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
- "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
- "name": "A String", # Name of this account permission.
- "level": "A String", # Administrative level required to enable this account permission.
- "permissionGroupId": "A String", # Permission group of this account permission.
- "accountProfiles": [ # Account profiles associated with this account permission.
- #
- # Possible values are:
- # - "ACCOUNT_PROFILE_BASIC"
- # - "ACCOUNT_PROFILE_STANDARD"
- "A String",
- ],
- "id": "A String", # ID of this account permission.
- },
- ],
- "kind": "dfareporting#accountPermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse".
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.accounts.html b/docs/dyn/dfareporting_v2_1.accounts.html
deleted file mode 100644
index c10f5bb..0000000
--- a/docs/dyn/dfareporting_v2_1.accounts.html
+++ /dev/null
@@ -1,790 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.accounts.html">accounts</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one account by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None)</a></code></p>
-<p class="firstline">Retrieves the list of accounts, possibly filtered.</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(profileId, 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(profileId, 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(profileId, id)</code>
- <pre>Gets one account by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Account ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM account.
- "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
- "countryId": "A String", # ID of the country associated with this account.
- "availablePermissionIds": [ # User role permissions available to the user roles of this account.
- "A String",
- ],
- "description": "A String", # Description of this account.
- "maximumImageSize": "A String", # Maximum image size allowed for this account.
- "currencyId": "A String", # ID of currency associated with this account. This is a required field.
- # Acceptable values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
- "accountPermissionIds": [ # Account permissions assigned to this account.
- "A String",
- ],
- "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
- "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
- "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
- "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
- "locale": "A String", # Locale of this account.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
- "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
- "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
- # Acceptable values are:
- #
- # - "1" for "America/New_York"
- # - "2" for "Europe/London"
- # - "3" for "Europe/Paris"
- # - "4" for "Africa/Johannesburg"
- # - "5" for "Asia/Jerusalem"
- # - "6" for "Asia/Shanghai"
- # - "7" for "Asia/Hong_Kong"
- # - "8" for "Asia/Tokyo"
- # - "9" for "Australia/Sydney"
- # - "10" for "Asia/Dubai"
- # - "11" for "America/Los_Angeles"
- # - "12" for "Pacific/Auckland"
- # - "13" for "America/Sao_Paulo"
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- },
- "active": True or False, # Whether this account is active.
- "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
- "id": "A String", # ID of this account. This is a read-only, auto-generated field.
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None)</code>
- <pre>Retrieves the list of accounts, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only accounts with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- active: boolean, Select only active accounts. Don't set this field to select both active and non-active accounts.
-
-Returns:
- An object of the form:
-
- { # Account List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse".
- "accounts": [ # Account collection.
- { # Contains properties of a DCM account.
- "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
- "countryId": "A String", # ID of the country associated with this account.
- "availablePermissionIds": [ # User role permissions available to the user roles of this account.
- "A String",
- ],
- "description": "A String", # Description of this account.
- "maximumImageSize": "A String", # Maximum image size allowed for this account.
- "currencyId": "A String", # ID of currency associated with this account. This is a required field.
- # Acceptable values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
- "accountPermissionIds": [ # Account permissions assigned to this account.
- "A String",
- ],
- "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
- "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
- "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
- "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
- "locale": "A String", # Locale of this account.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
- "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
- "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
- # Acceptable values are:
- #
- # - "1" for "America/New_York"
- # - "2" for "Europe/London"
- # - "3" for "Europe/Paris"
- # - "4" for "Africa/Johannesburg"
- # - "5" for "Asia/Jerusalem"
- # - "6" for "Asia/Shanghai"
- # - "7" for "Asia/Hong_Kong"
- # - "8" for "Asia/Tokyo"
- # - "9" for "Australia/Sydney"
- # - "10" for "Asia/Dubai"
- # - "11" for "America/Los_Angeles"
- # - "12" for "Pacific/Auckland"
- # - "13" for "America/Sao_Paulo"
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- },
- "active": True or False, # Whether this account is active.
- "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
- "id": "A String", # ID of this account. This is a read-only, auto-generated field.
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing account. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Account ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM account.
- "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
- "countryId": "A String", # ID of the country associated with this account.
- "availablePermissionIds": [ # User role permissions available to the user roles of this account.
- "A String",
- ],
- "description": "A String", # Description of this account.
- "maximumImageSize": "A String", # Maximum image size allowed for this account.
- "currencyId": "A String", # ID of currency associated with this account. This is a required field.
- # Acceptable values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
- "accountPermissionIds": [ # Account permissions assigned to this account.
- "A String",
- ],
- "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
- "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
- "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
- "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
- "locale": "A String", # Locale of this account.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
- "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
- "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
- # Acceptable values are:
- #
- # - "1" for "America/New_York"
- # - "2" for "Europe/London"
- # - "3" for "Europe/Paris"
- # - "4" for "Africa/Johannesburg"
- # - "5" for "Asia/Jerusalem"
- # - "6" for "Asia/Shanghai"
- # - "7" for "Asia/Hong_Kong"
- # - "8" for "Asia/Tokyo"
- # - "9" for "Australia/Sydney"
- # - "10" for "Asia/Dubai"
- # - "11" for "America/Los_Angeles"
- # - "12" for "Pacific/Auckland"
- # - "13" for "America/Sao_Paulo"
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- },
- "active": True or False, # Whether this account is active.
- "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
- "id": "A String", # ID of this account. This is a read-only, auto-generated field.
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM account.
- "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
- "countryId": "A String", # ID of the country associated with this account.
- "availablePermissionIds": [ # User role permissions available to the user roles of this account.
- "A String",
- ],
- "description": "A String", # Description of this account.
- "maximumImageSize": "A String", # Maximum image size allowed for this account.
- "currencyId": "A String", # ID of currency associated with this account. This is a required field.
- # Acceptable values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
- "accountPermissionIds": [ # Account permissions assigned to this account.
- "A String",
- ],
- "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
- "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
- "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
- "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
- "locale": "A String", # Locale of this account.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
- "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
- "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
- # Acceptable values are:
- #
- # - "1" for "America/New_York"
- # - "2" for "Europe/London"
- # - "3" for "Europe/Paris"
- # - "4" for "Africa/Johannesburg"
- # - "5" for "Asia/Jerusalem"
- # - "6" for "Asia/Shanghai"
- # - "7" for "Asia/Hong_Kong"
- # - "8" for "Asia/Tokyo"
- # - "9" for "Australia/Sydney"
- # - "10" for "Asia/Dubai"
- # - "11" for "America/Los_Angeles"
- # - "12" for "Pacific/Auckland"
- # - "13" for "America/Sao_Paulo"
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- },
- "active": True or False, # Whether this account is active.
- "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
- "id": "A String", # ID of this account. This is a read-only, auto-generated field.
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing account.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM account.
- "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
- "countryId": "A String", # ID of the country associated with this account.
- "availablePermissionIds": [ # User role permissions available to the user roles of this account.
- "A String",
- ],
- "description": "A String", # Description of this account.
- "maximumImageSize": "A String", # Maximum image size allowed for this account.
- "currencyId": "A String", # ID of currency associated with this account. This is a required field.
- # Acceptable values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
- "accountPermissionIds": [ # Account permissions assigned to this account.
- "A String",
- ],
- "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
- "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
- "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
- "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
- "locale": "A String", # Locale of this account.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
- "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
- "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
- # Acceptable values are:
- #
- # - "1" for "America/New_York"
- # - "2" for "Europe/London"
- # - "3" for "Europe/Paris"
- # - "4" for "Africa/Johannesburg"
- # - "5" for "Asia/Jerusalem"
- # - "6" for "Asia/Shanghai"
- # - "7" for "Asia/Hong_Kong"
- # - "8" for "Asia/Tokyo"
- # - "9" for "Australia/Sydney"
- # - "10" for "Asia/Dubai"
- # - "11" for "America/Los_Angeles"
- # - "12" for "Pacific/Auckland"
- # - "13" for "America/Sao_Paulo"
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- },
- "active": True or False, # Whether this account is active.
- "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
- "id": "A String", # ID of this account. This is a read-only, auto-generated field.
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM account.
- "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
- "countryId": "A String", # ID of the country associated with this account.
- "availablePermissionIds": [ # User role permissions available to the user roles of this account.
- "A String",
- ],
- "description": "A String", # Description of this account.
- "maximumImageSize": "A String", # Maximum image size allowed for this account.
- "currencyId": "A String", # ID of currency associated with this account. This is a required field.
- # Acceptable values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
- "accountPermissionIds": [ # Account permissions assigned to this account.
- "A String",
- ],
- "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
- "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
- "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
- "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
- "locale": "A String", # Locale of this account.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
- "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
- "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
- # Acceptable values are:
- #
- # - "1" for "America/New_York"
- # - "2" for "Europe/London"
- # - "3" for "Europe/Paris"
- # - "4" for "Africa/Johannesburg"
- # - "5" for "Asia/Jerusalem"
- # - "6" for "Asia/Shanghai"
- # - "7" for "Asia/Hong_Kong"
- # - "8" for "Asia/Tokyo"
- # - "9" for "Australia/Sydney"
- # - "10" for "Asia/Dubai"
- # - "11" for "America/Los_Angeles"
- # - "12" for "Pacific/Auckland"
- # - "13" for "America/Sao_Paulo"
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- },
- "active": True or False, # Whether this account is active.
- "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
- "id": "A String", # ID of this account. This is a read-only, auto-generated field.
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.ads.html b/docs/dyn/dfareporting_v2_1.ads.html
deleted file mode 100644
index 9132d66..0000000
--- a/docs/dyn/dfareporting_v2_1.ads.html
+++ /dev/null
@@ -1,2735 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.ads.html">ads</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one ad by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new ad.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None)</a></code></p>
-<p class="firstline">Retrieves a list of ads, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing ad. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing ad.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one ad by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Ad ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "code": "A String", # Postal code. This is equivalent to the id field.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new ad.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "code": "A String", # Postal code. This is equivalent to the id field.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "code": "A String", # Postal code. This is equivalent to the id field.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None)</code>
- <pre>Retrieves a list of ads, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- landingPageIds: string, Select only ads with these landing page IDs. (repeated)
- overriddenEventTagId: string, Select only ads with this event tag override ID.
- campaignIds: string, Select only ads with these campaign IDs. (repeated)
- sizeIds: string, Select only ads with these size IDs. (repeated)
- archived: boolean, Select only archived ads.
- creativeOptimizationConfigurationIds: string, Select only ads with these creative optimization configuration IDs. (repeated)
- sslCompliant: boolean, Select only ads that are SSL-compliant.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- type: string, Select only ads with these types. (repeated)
- Allowed values
- AD_SERVING_CLICK_TRACKER -
- AD_SERVING_DEFAULT_AD -
- AD_SERVING_STANDARD_AD -
- AD_SERVING_TRACKING -
- sslRequired: boolean, Select only ads that require SSL.
- creativeIds: string, Select only ads with these creative IDs assigned. (repeated)
- remarketingListIds: string, Select only ads whose list targeting expression use these remarketing list IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- creativeType: string, Select only ads with the specified creativeType.
- Allowed values
- BRAND_SAFE_DEFAULT_INSTREAM_VIDEO -
- CUSTOM_INPAGE -
- CUSTOM_INTERSTITIAL -
- ENHANCED_BANNER -
- ENHANCED_IMAGE -
- FLASH_INPAGE -
- HTML5_BANNER -
- IMAGE -
- INSTREAM_VIDEO -
- INTERNAL_REDIRECT -
- INTERSTITIAL_INTERNAL_REDIRECT -
- REDIRECT -
- RICH_MEDIA_EXPANDING -
- RICH_MEDIA_IM_EXPAND -
- RICH_MEDIA_INPAGE -
- RICH_MEDIA_INPAGE_FLOATING -
- RICH_MEDIA_INTERSTITIAL_FLOAT -
- RICH_MEDIA_MOBILE_IN_APP -
- RICH_MEDIA_MULTI_FLOATING -
- RICH_MEDIA_PEEL_DOWN -
- TRACKING_TEXT -
- VPAID_LINEAR -
- VPAID_NON_LINEAR -
- placementIds: string, Select only ads with these placement IDs assigned. (repeated)
- active: boolean, Select only active ads.
- compatibility: string, Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- Allowed values
- APP -
- APP_INTERSTITIAL -
- IN_STREAM_VIDEO -
- WEB -
- WEB_INTERSTITIAL -
- advertiserId: string, Select only ads with this advertiser ID.
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
- audienceSegmentIds: string, Select only ads with these audience segment IDs. (repeated)
- ids: string, Select only ads with these IDs. (repeated)
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- dynamicClickTracker: boolean, Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.
-
-Returns:
- An object of the form:
-
- { # Ad List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#adsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse".
- "ads": [ # Ad collection.
- { # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "code": "A String", # Postal code. This is equivalent to the id field.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing ad. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Ad ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "code": "A String", # Postal code. This is equivalent to the id field.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "code": "A String", # Postal code. This is equivalent to the id field.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing ad.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "code": "A String", # Postal code. This is equivalent to the id field.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM ad.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
- "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
- "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
- "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
- { # Contains information about a postal code that can be targeted by ads.
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "code": "A String", # Postal code. This is equivalent to the id field.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- },
- "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
- "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
- "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
- "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
- "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
- "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
- },
- "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Event tag overrides for this ad.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
- "remarketing_list_expression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
- "expression": "A String", # Expression describing which lists are being targeted by the ad.
- },
- "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
- "archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
- },
- ],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
- { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- },
- "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
- "creativeAssignments": [ # Creative assignments in this creative rotation.
- { # Creative Assignment.
- "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
- "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
- "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
- "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
- # Applicable when the creative type is any of the following:
- # - RICH_MEDIA_INPAGE
- # - RICH_MEDIA_INPAGE_FLOATING
- # - RICH_MEDIA_IM_EXPAND
- # - RICH_MEDIA_EXPANDING
- # - RICH_MEDIA_INTERSTITIAL_FLOAT
- # - RICH_MEDIA_MOBILE_IN_APP
- # - RICH_MEDIA_MULTI_FLOATING
- # - RICH_MEDIA_PEEL_DOWN
- # - ADVANCED_BANNER
- # - VPAID_LINEAR
- # - VPAID_NON_LINEAR
- { # Rich Media Exit Override.
- "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
- "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
- "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
- },
- ],
- "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
- { # Creative Group Assignment.
- "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
- "creativeGroupId": "A String", # ID of the creative group to be assigned.
- },
- ],
- "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
- { # Companion Click-through override.
- "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "creativeId": "A String", # ID of the creative for this companion click-through override.
- },
- ],
- "startTime": "A String", # Date and time that the assigned creative should start serving.
- "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
- "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
- "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
- "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
- "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
- "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
- },
- "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
- "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
- "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
- "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
- },
- "comments": "A String", # Comments for this ad.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
- "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "expression": "A String", # Keyword expression being targeted by the ad.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
- "active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
- "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
- "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
- "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
- "hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
- 42,
- ],
- "daysOfWeek": [ # Days of the week when the ad will serve.
- #
- # Acceptable values are:
- # - "SUNDAY"
- # - "MONDAY"
- # - "TUESDAY"
- # - "WEDNESDAY"
- # - "THURSDAY"
- # - "FRIDAY"
- # - "SATURDAY"
- "A String",
- ],
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
- "placementAssignments": [ # Placement assignments for this ad.
- { # Placement Assignment.
- "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
- "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementId": "A String", # ID of the placement to be assigned. This is a required field.
- "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
- },
- ],
- "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
- "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.advertisers.html b/docs/dyn/dfareporting_v2_1.advertisers.html
deleted file mode 100644
index 0db0e4c..0000000
--- a/docs/dyn/dfareporting_v2_1.advertisers.html
+++ /dev/null
@@ -1,467 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.advertisers.html">advertisers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one advertiser by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new advertiser.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None)</a></code></p>
-<p class="firstline">Retrieves a list of advertisers, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing advertiser. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing advertiser.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one advertiser by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Advertiser ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new advertiser.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None)</code>
- <pre>Retrieves a list of advertisers, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- includeAdvertisersWithoutGroupsOnly: boolean, Select only advertisers which do not belong to any advertiser group.
- onlyParent: boolean, Select only advertisers which use another advertiser's floodlight configuration.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- status: string, Select only advertisers with the specified status.
- Allowed values
- APPROVED -
- ON_HOLD -
- maxResults: integer, Maximum number of results to return.
- advertiserGroupIds: string, Select only advertisers with these advertiser group IDs. (repeated)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser".
- subaccountId: string, Select only advertisers with these subaccount IDs.
- ids: string, Select only advertisers with these IDs. (repeated)
- floodlightConfigurationIds: string, Select only advertisers with these floodlight configuration IDs. (repeated)
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
-
-Returns:
- An object of the form:
-
- { # Advertiser List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "advertisers": [ # Advertiser collection.
- { # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- },
- ],
- "kind": "dfareporting#advertisersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".
- }</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(profileId, id, body)</code>
- <pre>Updates an existing advertiser. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Advertiser ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing advertiser.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM advertiser.
- "status": "A String", # Status of this advertiser.
- "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
- "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
- "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
- "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
- "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
- # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
- # - This advertiser's original floodlight configuration is not already shared with another advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "defaultEmail": "A String", # Default email address used in sender field for tag emails.
- "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.campaignCreativeAssociations.html b/docs/dyn/dfareporting_v2_1.campaignCreativeAssociations.html
deleted file mode 100644
index 2756579..0000000
--- a/docs/dyn/dfareporting_v2_1.campaignCreativeAssociations.html
+++ /dev/null
@@ -1,155 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.campaignCreativeAssociations.html">campaignCreativeAssociations</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, campaignId, body)</a></code></p>
-<p class="firstline">Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves the list of creative IDs associated with the specified campaign.</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="insert">insert(profileId, campaignId, body)</code>
- <pre>Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Campaign ID in this association. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Identifies a creative which has been associated with a given campaign.
- "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
- "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
- }
-
-
-Returns:
- An object of the form:
-
- { # Identifies a creative which has been associated with a given campaign.
- "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
- "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None)</code>
- <pre>Retrieves the list of creative IDs associated with the specified campaign.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Campaign ID in this association. (required)
- maxResults: integer, Maximum number of results to return.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Campaign Creative Association List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "campaignCreativeAssociations": [ # Campaign creative association collection
- { # Identifies a creative which has been associated with a given campaign.
- "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
- "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
- },
- ],
- "kind": "dfareporting#campaignCreativeAssociationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse".
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.campaigns.html b/docs/dyn/dfareporting_v2_1.campaigns.html
deleted file mode 100644
index 6dc1981..0000000
--- a/docs/dyn/dfareporting_v2_1.campaigns.html
+++ /dev/null
@@ -1,1139 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.campaigns.html">campaigns</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one campaign by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body)</a></code></p>
-<p class="firstline">Inserts a new campaign.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None)</a></code></p>
-<p class="firstline">Retrieves a list of campaigns, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing campaign. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing campaign.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one campaign by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Campaign ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body)</code>
- <pre>Inserts a new campaign.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- defaultLandingPageName: string, Default landing page name for this new campaign. Must be less than 256 characters long. (required)
- defaultLandingPageUrl: string, Default landing page URL for this new campaign. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None)</code>
- <pre>Retrieves a list of campaigns, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- overriddenEventTagId: string, Select only campaigns that have overridden this event tag ID.
- archived: boolean, Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
- advertiserIds: string, Select only campaigns that belong to these advertisers. (repeated)
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- maxResults: integer, Maximum number of results to return.
- excludedIds: string, Exclude campaigns with these IDs. (repeated)
- advertiserGroupIds: string, Select only campaigns whose advertisers belong to these advertiser groups. (repeated)
- searchString: string, Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
- subaccountId: string, Select only campaigns that belong to this subaccount.
- ids: string, Select only campaigns with these IDs. (repeated)
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- atLeastOneOptimizationActivity: boolean, Select only campaigns that have at least one optimization activity.
-
-Returns:
- An object of the form:
-
- { # Campaign List Response
- "campaigns": [ # Campaign collection.
- { # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- },
- ],
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#campaignsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".
- }</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(profileId, id, body)</code>
- <pre>Updates an existing campaign. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Campaign ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing campaign.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM campaign.
- "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
- "startDate": "A String", # Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
- "endDate": "A String", # Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
- "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
- "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
- "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
- },
- "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
- { # Event tag override information.
- "enabled": True or False, # Whether this override is enabled.
- "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
- },
- ],
- "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
- "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
- "traffickerEmails": [ # Campaign trafficker contact emails.
- "A String",
- ],
- "archived": True or False, # Whether this campaign has been archived.
- "externalId": "A String", # External ID for this campaign.
- "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
- "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
- "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
- "A String",
- ],
- "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
- { # Creative optimization settings.
- "optimizationActivitys": [ # List of optimization activities associated with this configuration.
- { # Creative optimization activity.
- "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
- "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "weight": 42, # Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.
- },
- ],
- "optimizationModel": "A String", # Optimization model for this configuration.
- "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
- "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
- },
- ],
- "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
- "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
- "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
- },
- "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
- "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
- "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
- { # Audience Segment Group.
- "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
- { # Audience Segment.
- "allocation": 42, # Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.
- "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
- },
- ],
- "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.changeLogs.html b/docs/dyn/dfareporting_v2_1.changeLogs.html
deleted file mode 100644
index 03708e3..0000000
--- a/docs/dyn/dfareporting_v2_1.changeLogs.html
+++ /dev/null
@@ -1,228 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.changeLogs.html">changeLogs</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one change log by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None)</a></code></p>
-<p class="firstline">Retrieves a list of change logs.</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(profileId, id)</code>
- <pre>Gets one change log by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Change log ID. (required)
-
-Returns:
- An object of the form:
-
- { # Describes a change that a user has made to a resource.
- "changeTime": "A String", # Time when the object was modified.
- "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
- "subaccountId": "A String", # Subaccount ID of the modified object.
- "userProfileId": "A String", # ID of the user who modified the object.
- "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
- "newValue": "A String", # New value of the object field.
- "userProfileName": "A String", # User profile name of the user who modified the object.
- "fieldName": "A String", # Field name of the object which changed.
- "oldValue": "A String", # Old value of the object field.
- "action": "A String", # Action which caused the change.
- "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
- "objectType": "A String", # Object type of the change log.
- "id": "A String", # ID of this change log.
- "accountId": "A String", # Account ID of the modified object.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None)</code>
- <pre>Retrieves a list of change logs.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- objectType: string, Select only change logs with the specified object type.
- Allowed values
- OBJECT_ACCOUNT -
- OBJECT_ACCOUNT_BILLING_FEATURE -
- OBJECT_AD -
- OBJECT_ADVERTISER -
- OBJECT_ADVERTISER_GROUP -
- OBJECT_BILLING_ACCOUNT_GROUP -
- OBJECT_BILLING_FEATURE -
- OBJECT_BILLING_MINIMUM_FEE -
- OBJECT_BILLING_PROFILE -
- OBJECT_CAMPAIGN -
- OBJECT_CONTENT_CATEGORY -
- OBJECT_CREATIVE -
- OBJECT_CREATIVE_ASSET -
- OBJECT_CREATIVE_BUNDLE -
- OBJECT_CREATIVE_FIELD -
- OBJECT_CREATIVE_GROUP -
- OBJECT_DFA_SITE -
- OBJECT_EVENT_TAG -
- OBJECT_FLOODLIGHT_ACTIVITY_GROUP -
- OBJECT_FLOODLIGHT_ACTVITY -
- OBJECT_FLOODLIGHT_CONFIGURATION -
- OBJECT_INSTREAM_CREATIVE -
- OBJECT_LANDING_PAGE -
- OBJECT_MEDIA_ORDER -
- OBJECT_PLACEMENT -
- OBJECT_PLACEMENT_STRATEGY -
- OBJECT_PROVIDED_LIST_CLIENT -
- OBJECT_RATE_CARD -
- OBJECT_REMARKETING_LIST -
- OBJECT_RICHMEDIA_CREATIVE -
- OBJECT_SD_SITE -
- OBJECT_SIZE -
- OBJECT_SUBACCOUNT -
- OBJECT_USER_PROFILE -
- OBJECT_USER_PROFILE_FILTER -
- OBJECT_USER_ROLE -
- maxChangeTime: string, Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
- pageToken: string, Value of the nextPageToken from the previous result page.
- maxResults: integer, Maximum number of results to return.
- action: string, Select only change logs with the specified action.
- Allowed values
- ACTION_ADD -
- ACTION_ASSIGN -
- ACTION_ASSOCIATE -
- ACTION_CREATE -
- ACTION_DELETE -
- ACTION_DISABLE -
- ACTION_EMAIL_TAGS -
- ACTION_ENABLE -
- ACTION_LINK -
- ACTION_MARK_AS_DEFAULT -
- ACTION_PUSH -
- ACTION_REMOVE -
- ACTION_SEND -
- ACTION_UNASSIGN -
- ACTION_UNLINK -
- ACTION_UPDATE -
- minChangeTime: string, Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
- searchString: string, Select only change logs whose object ID, user name, old or new values match the search string.
- userProfileIds: string, Select only change logs with these user profile IDs. (repeated)
- ids: string, Select only change logs with these IDs. (repeated)
- objectIds: string, Select only change logs with these object IDs. (repeated)
-
-Returns:
- An object of the form:
-
- { # Change Log List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#changeLogsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse".
- "changeLogs": [ # Change log collection.
- { # Describes a change that a user has made to a resource.
- "changeTime": "A String", # Time when the object was modified.
- "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
- "subaccountId": "A String", # Subaccount ID of the modified object.
- "userProfileId": "A String", # ID of the user who modified the object.
- "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
- "newValue": "A String", # New value of the object field.
- "userProfileName": "A String", # User profile name of the user who modified the object.
- "fieldName": "A String", # Field name of the object which changed.
- "oldValue": "A String", # Old value of the object field.
- "action": "A String", # Action which caused the change.
- "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
- "objectType": "A String", # Object type of the change log.
- "id": "A String", # ID of this change log.
- "accountId": "A String", # Account ID of the modified object.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.connectionTypes.html b/docs/dyn/dfareporting_v2_1.connectionTypes.html
deleted file mode 100644
index 261afbb..0000000
--- a/docs/dyn/dfareporting_v2_1.connectionTypes.html
+++ /dev/null
@@ -1,124 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.connectionTypes.html">connectionTypes</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one connection type by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of connection types.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one connection type by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Connection type ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of connection types.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Connection Type List Response
- "kind": "dfareporting#connectionTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse".
- "connectionTypes": [ # Collection of connection types such as broadband and mobile.
- { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
- "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
- "id": "A String", # ID of this connection type.
- "name": "A String", # Name of this connection type.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.creativeAssets.html b/docs/dyn/dfareporting_v2_1.creativeAssets.html
deleted file mode 100644
index 906e7da..0000000
--- a/docs/dyn/dfareporting_v2_1.creativeAssets.html
+++ /dev/null
@@ -1,185 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.creativeAssets.html">creativeAssets</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, advertiserId, body=None, media_body=None)</a></code></p>
-<p class="firstline">Inserts a new creative asset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="insert">insert(profileId, advertiserId, body=None, media_body=None)</code>
- <pre>Inserts a new creative asset.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- advertiserId: string, Advertiser ID of this creative. This is a required field. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
- "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
- #
- # Possible values are:
- # - "CLICK_TAG_NON_TOP_LEVEL"
- # - "CLICK_TAG_MISSING"
- # - "CLICK_TAG_MORE_THAN_ONE"
- # - "CLICK_TAG_INVALID"
- # - "ORPHANED_ASSET"
- # - "PRIMARY_HTML_MISSING"
- # - "EXTERNAL_FILE_REFERENCED"
- # - "MRAID_REFERENCED"
- # - "ADMOB_REFERENCED"
- # - "FILE_TYPE_INVALID"
- # - "ZIP_INVALID"
- # - "LINKED_FILE_NOT_FOUND"
- # - "MAX_FLASH_VERSION_11"
- # - "NOT_SSL_COMPLIANT"
- # - "FILE_DETAIL_EMPTY"
- # - "ASSET_INVALID"
- # - "GWD_PROPERTIES_INVALID"
- # - "ENABLER_UNSUPPORTED_METHOD_DCM"
- # - "ASSET_FORMAT_UNSUPPORTED_DCM"
- # - "COMPONENT_UNSUPPORTED_DCM"
- # - "HTML5_FEATURE_UNSUPPORTED' "
- "A String",
- ],
- "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
- "A String",
- ],
- "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
- "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- }
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
-
-Returns:
- An object of the form:
-
- { # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
- "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
- #
- # Possible values are:
- # - "CLICK_TAG_NON_TOP_LEVEL"
- # - "CLICK_TAG_MISSING"
- # - "CLICK_TAG_MORE_THAN_ONE"
- # - "CLICK_TAG_INVALID"
- # - "ORPHANED_ASSET"
- # - "PRIMARY_HTML_MISSING"
- # - "EXTERNAL_FILE_REFERENCED"
- # - "MRAID_REFERENCED"
- # - "ADMOB_REFERENCED"
- # - "FILE_TYPE_INVALID"
- # - "ZIP_INVALID"
- # - "LINKED_FILE_NOT_FOUND"
- # - "MAX_FLASH_VERSION_11"
- # - "NOT_SSL_COMPLIANT"
- # - "FILE_DETAIL_EMPTY"
- # - "ASSET_INVALID"
- # - "GWD_PROPERTIES_INVALID"
- # - "ENABLER_UNSUPPORTED_METHOD_DCM"
- # - "ASSET_FORMAT_UNSUPPORTED_DCM"
- # - "COMPONENT_UNSUPPORTED_DCM"
- # - "HTML5_FEATURE_UNSUPPORTED' "
- "A String",
- ],
- "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
- "A String",
- ],
- "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
- "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.creatives.html b/docs/dyn/dfareporting_v2_1.creatives.html
deleted file mode 100644
index 975e39f..0000000
--- a/docs/dyn/dfareporting_v2_1.creatives.html
+++ /dev/null
@@ -1,2876 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.creatives.html">creatives</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one creative by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new creative.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None)</a></code></p>
-<p class="firstline">Retrieves a list of creatives, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing creative. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing creative.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one creative by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new creative.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None)</code>
- <pre>Retrieves a list of creatives, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Select only creatives with this campaign ID.
- advertiserId: string, Select only creatives with this advertiser ID.
- sizeIds: string, Select only creatives with these size IDs. (repeated)
- archived: boolean, Select only archived creatives. Leave blank to select archived and unarchived creatives.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- renderingIds: string, Select only creatives with these rendering IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- active: boolean, Select only active creatives. Leave blank to select active and inactive creatives.
- companionCreativeIds: string, Select only in-stream video creatives with these companion IDs. (repeated)
- types: string, Select only creatives with these creative types. (repeated)
- Allowed values
- BRAND_SAFE_DEFAULT_INSTREAM_VIDEO -
- CUSTOM_INPAGE -
- CUSTOM_INTERSTITIAL -
- ENHANCED_BANNER -
- ENHANCED_IMAGE -
- FLASH_INPAGE -
- HTML5_BANNER -
- IMAGE -
- INSTREAM_VIDEO -
- INTERNAL_REDIRECT -
- INTERSTITIAL_INTERNAL_REDIRECT -
- REDIRECT -
- RICH_MEDIA_EXPANDING -
- RICH_MEDIA_IM_EXPAND -
- RICH_MEDIA_INPAGE -
- RICH_MEDIA_INPAGE_FLOATING -
- RICH_MEDIA_INTERSTITIAL_FLOAT -
- RICH_MEDIA_MOBILE_IN_APP -
- RICH_MEDIA_MULTI_FLOATING -
- RICH_MEDIA_PEEL_DOWN -
- TRACKING_TEXT -
- VPAID_LINEAR -
- VPAID_NON_LINEAR -
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
- ids: string, Select only creatives with these IDs. (repeated)
- studioCreativeId: string, Select only creatives corresponding to this Studio creative ID.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- creativeFieldIds: string, Select only creatives with these creative field IDs. (repeated)
-
-Returns:
- An object of the form:
-
- { # Creative List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#creativesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".
- "creatives": [ # Creative collection.
- { # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing creative. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing creative.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Creative.
- "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
- "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
- "windowHeight": 42, # Height of the window.
- "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- "windowWidth": 42, # Width of the window.
- "positionOption": "A String", # Position in the browser where the window will open.
- "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
- },
- "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
- "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
- "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- { # Creative Custom Event.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- ],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
- "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
- "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
- { # Creative Field Assignment.
- "creativeFieldId": "A String", # ID of the creative field.
- "creativeFieldValueId": "A String", # ID of the creative field value.
- },
- ],
- "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
- "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
- "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
- "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- { # Creative Asset.
- "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
- "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
- "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
- "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.
- # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
- # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
- # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
- # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
- # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
- # For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
- "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.
- "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
- "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "active": True or False, # Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
- "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "zIndex": 42, # zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.
- "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
- "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
- "targetType": "A String", # Target type used by the event.
- "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
- "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
- "showStatusBar": True or False, # Whether to display the browser status bar.
- "showScrollBar": True or False, # Whether to display the browser scroll bar.
- "showAddressBar": True or False, # Whether to display the browser address bar.
- "showMenuBar": True or False, # Whether to display the browser menu bar.
- "title": "A String", # Title of popup window.
- "showToolBar": True or False, # Whether to display the browser tool bar.
- "positionType": "A String", # Popup window position either centered or at specific coordinate.
- "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- },
- "artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
- "active": True or False, # Whether the event is active.
- "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
- "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
- "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
- "advertiserCustomEventName": "A String", # User-entered name for the event.
- },
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
- "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
- "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
- "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
- "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
- "top": 42, # Offset distance from top side of an asset or a window.
- "left": 42, # Offset distance from left side of an asset or a window.
- },
- "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
- },
- ],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
- "htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
- #
- # Acceptable values are:
- # - "APP"
- # - "APP_INTERSTITIAL"
- # - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
- "A String",
- ],
- "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
- "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "A String",
- ],
- "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
- "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
- "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
- "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
- "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
- "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- "A String",
- ],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
- "A String",
- ],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
- "customHtml": "A String", # User-entered value.
- "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
- },
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.dimensionValues.html b/docs/dyn/dfareporting_v2_1.dimensionValues.html
deleted file mode 100644
index 2d9bbdc..0000000
--- a/docs/dyn/dfareporting_v2_1.dimensionValues.html
+++ /dev/null
@@ -1,144 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.directorySiteContacts.html b/docs/dyn/dfareporting_v2_1.directorySiteContacts.html
deleted file mode 100644
index 13ae8d6..0000000
--- a/docs/dyn/dfareporting_v2_1.directorySiteContacts.html
+++ /dev/null
@@ -1,169 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.directorySiteContacts.html">directorySiteContacts</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one directory site contact by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of directory site contacts, possibly filtered.</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(profileId, id)</code>
- <pre>Gets one directory site contact by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Directory site contact ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Site Directory contact.
- "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
- "firstName": "A String", # First name of this directory site contact.
- "title": "A String", # Title or designation of this directory site contact.
- "lastName": "A String", # Last name of this directory site contact.
- "email": "A String", # Email address of this directory site contact.
- "phone": "A String", # Phone number of this directory site contact.
- "role": "A String", # Directory site contact role.
- "address": "A String", # Address of this directory site contact.
- "type": "A String", # Directory site contact type.
- "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Retrieves a list of directory site contacts, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact".
- directorySiteIds: string, Select only directory site contacts with these directory site IDs. This is a required field. (repeated)
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only directory site contacts with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Directory Site Contact List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "directorySiteContacts": [ # Directory site contact collection
- { # Contains properties of a Site Directory contact.
- "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
- "firstName": "A String", # First name of this directory site contact.
- "title": "A String", # Title or designation of this directory site contact.
- "lastName": "A String", # Last name of this directory site contact.
- "email": "A String", # Email address of this directory site contact.
- "phone": "A String", # Phone number of this directory site contact.
- "role": "A String", # Directory site contact role.
- "address": "A String", # Address of this directory site contact.
- "type": "A String", # Directory site contact type.
- "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
- },
- ],
- "kind": "dfareporting#directorySiteContactsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse".
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.directorySites.html b/docs/dyn/dfareporting_v2_1.directorySites.html
deleted file mode 100644
index 3877160..0000000
--- a/docs/dyn/dfareporting_v2_1.directorySites.html
+++ /dev/null
@@ -1,546 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.directorySites.html">directorySites</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one directory site by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new directory site.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None)</a></code></p>
-<p class="firstline">Retrieves a list of directory sites, possibly filtered.</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(profileId, id)</code>
- <pre>Gets one directory site by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Directory site ID. (required)
-
-Returns:
- An object of the form:
-
- { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
- "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
- "countryId": "A String", # Country ID of this directory site.
- "description": "A String", # Description of this directory site.
- "settings": { # Directory Site Settings # Directory site settings.
- "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
- "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
- "dfp_settings": { # DFP Settings # Directory site DFP settings.
- "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
- "dfp_network_name": "A String", # DFP network name for this directory site.
- "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
- "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
- "dfp_network_code": "A String", # DFP network code for this directory site.
- },
- "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
- "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
- "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
- "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
- },
- "currencyId": "A String", # Currency ID of this directory site.
- # Possible values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "inpageTagFormats": [ # Tag types for regular placements.
- #
- # Acceptable values are:
- # - "STANDARD"
- # - "IFRAME_JAVASCRIPT_INPAGE"
- # - "INTERNAL_REDIRECT_INPAGE"
- # - "JAVASCRIPT_INPAGE"
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "interstitialTagFormats": [ # Tag types for interstitial placements.
- #
- # Acceptable values are:
- # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
- # - "INTERNAL_REDIRECT_INTERSTITIAL"
- # - "JAVASCRIPT_INTERSTITIAL"
- "A String",
- ],
- "contactAssignments": [ # Directory site contacts.
- { # Directory Site Contact Assignment
- "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
- "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
- },
- ],
- "url": "A String", # URL of this directory site.
- "parentId": "A String", # Parent directory site ID.
- "active": True or False, # Whether this directory site is active.
- "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
- "name": "A String", # Name of this directory site.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new directory site.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
- "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
- "countryId": "A String", # Country ID of this directory site.
- "description": "A String", # Description of this directory site.
- "settings": { # Directory Site Settings # Directory site settings.
- "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
- "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
- "dfp_settings": { # DFP Settings # Directory site DFP settings.
- "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
- "dfp_network_name": "A String", # DFP network name for this directory site.
- "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
- "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
- "dfp_network_code": "A String", # DFP network code for this directory site.
- },
- "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
- "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
- "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
- "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
- },
- "currencyId": "A String", # Currency ID of this directory site.
- # Possible values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "inpageTagFormats": [ # Tag types for regular placements.
- #
- # Acceptable values are:
- # - "STANDARD"
- # - "IFRAME_JAVASCRIPT_INPAGE"
- # - "INTERNAL_REDIRECT_INPAGE"
- # - "JAVASCRIPT_INPAGE"
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "interstitialTagFormats": [ # Tag types for interstitial placements.
- #
- # Acceptable values are:
- # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
- # - "INTERNAL_REDIRECT_INTERSTITIAL"
- # - "JAVASCRIPT_INTERSTITIAL"
- "A String",
- ],
- "contactAssignments": [ # Directory site contacts.
- { # Directory Site Contact Assignment
- "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
- "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
- },
- ],
- "url": "A String", # URL of this directory site.
- "parentId": "A String", # Parent directory site ID.
- "active": True or False, # Whether this directory site is active.
- "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
- "name": "A String", # Name of this directory site.
- }
-
-
-Returns:
- An object of the form:
-
- { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
- "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
- "countryId": "A String", # Country ID of this directory site.
- "description": "A String", # Description of this directory site.
- "settings": { # Directory Site Settings # Directory site settings.
- "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
- "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
- "dfp_settings": { # DFP Settings # Directory site DFP settings.
- "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
- "dfp_network_name": "A String", # DFP network name for this directory site.
- "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
- "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
- "dfp_network_code": "A String", # DFP network code for this directory site.
- },
- "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
- "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
- "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
- "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
- },
- "currencyId": "A String", # Currency ID of this directory site.
- # Possible values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "inpageTagFormats": [ # Tag types for regular placements.
- #
- # Acceptable values are:
- # - "STANDARD"
- # - "IFRAME_JAVASCRIPT_INPAGE"
- # - "INTERNAL_REDIRECT_INPAGE"
- # - "JAVASCRIPT_INPAGE"
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "interstitialTagFormats": [ # Tag types for interstitial placements.
- #
- # Acceptable values are:
- # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
- # - "INTERNAL_REDIRECT_INTERSTITIAL"
- # - "JAVASCRIPT_INTERSTITIAL"
- "A String",
- ],
- "contactAssignments": [ # Directory site contacts.
- { # Directory Site Contact Assignment
- "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
- "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
- },
- ],
- "url": "A String", # URL of this directory site.
- "parentId": "A String", # Parent directory site ID.
- "active": True or False, # Whether this directory site is active.
- "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
- "name": "A String", # Name of this directory site.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None)</code>
- <pre>Retrieves a list of directory sites, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- countryId: string, Select only directory sites with this country ID.
- acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- parentId: string, Select only directory sites with this parent ID.
- acceptsPublisherPaidPlacements: boolean, Select only directory sites that accept publisher paid placements. This field can be left blank.
- acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
- maxResults: integer, Maximum number of results to return.
- active: boolean, Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
- searchString: string, Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only directory sites with these IDs. (repeated)
- dfp_network_code: string, Select only directory sites with this DFP network code.
-
-Returns:
- An object of the form:
-
- { # Directory Site List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#directorySitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse".
- "directorySites": [ # Directory site collection.
- { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
- "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
- "countryId": "A String", # Country ID of this directory site.
- "description": "A String", # Description of this directory site.
- "settings": { # Directory Site Settings # Directory site settings.
- "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
- "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
- "dfp_settings": { # DFP Settings # Directory site DFP settings.
- "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
- "dfp_network_name": "A String", # DFP network name for this directory site.
- "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
- "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
- "dfp_network_code": "A String", # DFP network code for this directory site.
- },
- "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
- "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
- "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
- "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
- },
- "currencyId": "A String", # Currency ID of this directory site.
- # Possible values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "inpageTagFormats": [ # Tag types for regular placements.
- #
- # Acceptable values are:
- # - "STANDARD"
- # - "IFRAME_JAVASCRIPT_INPAGE"
- # - "INTERNAL_REDIRECT_INPAGE"
- # - "JAVASCRIPT_INPAGE"
- "A String",
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "interstitialTagFormats": [ # Tag types for interstitial placements.
- #
- # Acceptable values are:
- # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
- # - "INTERNAL_REDIRECT_INTERSTITIAL"
- # - "JAVASCRIPT_INTERSTITIAL"
- "A String",
- ],
- "contactAssignments": [ # Directory site contacts.
- { # Directory Site Contact Assignment
- "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
- "visibility": "A String", # Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.
- },
- ],
- "url": "A String", # URL of this directory site.
- "parentId": "A String", # Parent directory site ID.
- "active": True or False, # Whether this directory site is active.
- "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
- "name": "A String", # Name of this directory site.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.eventTags.html b/docs/dyn/dfareporting_v2_1.eventTags.html
deleted file mode 100644
index 4a4c433..0000000
--- a/docs/dyn/dfareporting_v2_1.eventTags.html
+++ /dev/null
@@ -1,485 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.eventTags.html">eventTags</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing event tag.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one event tag by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new event tag.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None)</a></code></p>
-<p class="firstline">Retrieves a list of event tags, possibly filtered.</p>
-<p class="toc_element">
- <code><a href="#patch">patch(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing event tag. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing event tag.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing event tag.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Event tag ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one event tag by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Event tag ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new event tag.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None)</code>
- <pre>Retrieves a list of event tags, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Select only event tags that belong to this campaign.
- advertiserId: string, Select only event tags that belong to this advertiser.
- adId: string, Select only event tags that belong to this ad.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- definitionsOnly: boolean, Examine only the specified ad or campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign is examined as well. In addition, when set to false, the status field is examined as well along with the enabledByDefault field.
- eventTagTypes: string, Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. (repeated)
- Allowed values
- CLICK_THROUGH_EVENT_TAG -
- IMPRESSION_IMAGE_EVENT_TAG -
- IMPRESSION_JAVASCRIPT_EVENT_TAG -
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- enabled: boolean, Select only enabled event tags. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.
- ids: string, Select only event tags with these IDs. (repeated)
-
-Returns:
- An object of the form:
-
- { # Event Tag List Response
- "eventTags": [ # Event tag collection.
- { # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- },
- ],
- "kind": "dfareporting#eventTagsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse".
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(profileId, id, body)</code>
- <pre>Updates an existing event tag. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Event tag ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing event tag.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of an event tag.
- "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
- "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
- "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
- "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
- "sslCompliant": True or False, # Whether this tag is SSL-compliant or not.
- "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
- "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
- "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
- "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
- "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
- "A String",
- ],
- "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
- "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.files.html b/docs/dyn/dfareporting_v2_1.files.html
deleted file mode 100644
index 54aa8d2..0000000
--- a/docs/dyn/dfareporting_v2_1.files.html
+++ /dev/null
@@ -1,205 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.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 metadata 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.
- "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.
- },
- "fileName": "A String", # The filename 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 metadata 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.
- "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.
- },
- "fileName": "A String", # The filename 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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.floodlightActivities.html b/docs/dyn/dfareporting_v2_1.floodlightActivities.html
deleted file mode 100644
index e9b3302..0000000
--- a/docs/dyn/dfareporting_v2_1.floodlightActivities.html
+++ /dev/null
@@ -1,1045 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.floodlightActivities.html">floodlightActivities</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing floodlight activity.</p>
-<p class="toc_element">
- <code><a href="#generatetag">generatetag(profileId, floodlightActivityId=None)</a></code></p>
-<p class="firstline">Generates a tag for a floodlight activity.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one floodlight activity by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new floodlight activity.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)</a></code></p>
-<p class="firstline">Retrieves a list of floodlight activities, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing floodlight activity. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing floodlight activity.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing floodlight activity.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="generatetag">generatetag(profileId, floodlightActivityId=None)</code>
- <pre>Generates a tag for a floodlight activity.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- floodlightActivityId: string, Floodlight activity ID for which we want to generate a tag.
-
-Returns:
- An object of the form:
-
- { # Floodlight Activity GenerateTag Response
- "kind": "dfareporting#floodlightActivitiesGenerateTagResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse".
- "floodlightActivityTag": "A String", # Generated tag for this floodlight activity.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one floodlight activity by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new floodlight activity.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)</code>
- <pre>Retrieves a list of floodlight activities, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name.
- advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
- tagString: string, Select only floodlight activities with the specified tag string.
- floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string.
- floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated)
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- maxResults: integer, Maximum number of results to return.
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
- ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated)
- floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type.
- Allowed values
- COUNTER -
- SALE -
-
-Returns:
- An object of the form:
-
- { # Floodlight Activity List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#floodlightActivitiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".
- "floodlightActivities": [ # Floodlight activity collection.
- { # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing floodlight activity. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing floodlight activity.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.floodlightActivityGroups.html b/docs/dyn/dfareporting_v2_1.floodlightActivityGroups.html
deleted file mode 100644
index 7668dd0..0000000
--- a/docs/dyn/dfareporting_v2_1.floodlightActivityGroups.html
+++ /dev/null
@@ -1,501 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.floodlightActivityGroups.html">floodlightActivityGroups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing floodlight activity group.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one floodlight activity group by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new floodlight activity group.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None)</a></code></p>
-<p class="firstline">Retrieves a list of floodlight activity groups, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing floodlight activity group. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing floodlight activity group.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing floodlight activity group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity Group ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one floodlight activity group by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity Group ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new floodlight activity group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None)</code>
- <pre>Retrieves a list of floodlight activity groups, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- advertiserId: string, Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- floodlightConfigurationId: string, Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
- ids: string, Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- type: string, Select only floodlight activity groups with the specified floodlight activity group type.
- Allowed values
- COUNTER -
- SALE -
-
-Returns:
- An object of the form:
-
- { # Floodlight Activity Group List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#floodlightActivityGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse".
- "floodlightActivityGroups": [ # Floodlight activity group collection.
- { # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing floodlight activity group. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity Group ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing floodlight activity group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity group.
- "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
- "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.floodlightConfigurations.html b/docs/dyn/dfareporting_v2_1.floodlightConfigurations.html
deleted file mode 100644
index 2ec6656..0000000
--- a/docs/dyn/dfareporting_v2_1.floodlightConfigurations.html
+++ /dev/null
@@ -1,478 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.floodlightConfigurations.html">floodlightConfigurations</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one floodlight configuration by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, ids=None)</a></code></p>
-<p class="firstline">Retrieves a list of floodlight configurations, possibly filtered.</p>
-<p class="toc_element">
- <code><a href="#patch">patch(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing floodlight configuration. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing floodlight configuration.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one floodlight configuration by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight configuration ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight configuration.
- "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
- "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
- "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
- "imageTagEnabled": True or False, # Whether image tags are enabled.
- },
- "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
- "standardVariableTypes": [ # List of standard variables enabled for this configuration.
- #
- # Acceptable values are:
- # - "ORD"
- # - "NUM"
- "A String",
- ],
- "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
- "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
- "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
- },
- "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
- "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
- "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
- "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, ids=None)</code>
- <pre>Retrieves a list of floodlight configurations, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- ids: string, Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. (repeated)
-
-Returns:
- An object of the form:
-
- { # Floodlight Configuration List Response
- "floodlightConfigurations": [ # Floodlight configuration collection.
- { # Contains properties of a Floodlight configuration.
- "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
- "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
- "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
- "imageTagEnabled": True or False, # Whether image tags are enabled.
- },
- "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
- "standardVariableTypes": [ # List of standard variables enabled for this configuration.
- #
- # Acceptable values are:
- # - "ORD"
- # - "NUM"
- "A String",
- ],
- "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
- "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
- "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
- },
- "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
- "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
- "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
- "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
- },
- ],
- "kind": "dfareporting#floodlightConfigurationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse".
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(profileId, id, body)</code>
- <pre>Updates an existing floodlight configuration. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight configuration ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight configuration.
- "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
- "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
- "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
- "imageTagEnabled": True or False, # Whether image tags are enabled.
- },
- "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
- "standardVariableTypes": [ # List of standard variables enabled for this configuration.
- #
- # Acceptable values are:
- # - "ORD"
- # - "NUM"
- "A String",
- ],
- "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
- "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
- "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
- },
- "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
- "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
- "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
- "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight configuration.
- "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
- "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
- "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
- "imageTagEnabled": True or False, # Whether image tags are enabled.
- },
- "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
- "standardVariableTypes": [ # List of standard variables enabled for this configuration.
- #
- # Acceptable values are:
- # - "ORD"
- # - "NUM"
- "A String",
- ],
- "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
- "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
- "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
- },
- "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
- "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
- "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
- "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing floodlight configuration.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight configuration.
- "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
- "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
- "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
- "imageTagEnabled": True or False, # Whether image tags are enabled.
- },
- "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
- "standardVariableTypes": [ # List of standard variables enabled for this configuration.
- #
- # Acceptable values are:
- # - "ORD"
- # - "NUM"
- "A String",
- ],
- "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
- "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
- "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
- },
- "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
- "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
- "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
- "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight configuration.
- "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
- "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
- "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
- "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
- "imageTagEnabled": True or False, # Whether image tags are enabled.
- },
- "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
- "standardVariableTypes": [ # List of standard variables enabled for this configuration.
- #
- # Acceptable values are:
- # - "ORD"
- # - "NUM"
- "A String",
- ],
- "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
- "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
- "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
- },
- "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
- "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
- "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
- "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.html b/docs/dyn/dfareporting_v2_1.html
deleted file mode 100644
index 6a19351..0000000
--- a/docs/dyn/dfareporting_v2_1.html
+++ /dev/null
@@ -1,373 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.accountActiveAdSummaries.html">accountActiveAdSummaries()</a></code>
-</p>
-<p class="firstline">Returns the accountActiveAdSummaries Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.accountPermissionGroups.html">accountPermissionGroups()</a></code>
-</p>
-<p class="firstline">Returns the accountPermissionGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.accountPermissions.html">accountPermissions()</a></code>
-</p>
-<p class="firstline">Returns the accountPermissions Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.accountUserProfiles.html">accountUserProfiles()</a></code>
-</p>
-<p class="firstline">Returns the accountUserProfiles Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.accounts.html">accounts()</a></code>
-</p>
-<p class="firstline">Returns the accounts Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.ads.html">ads()</a></code>
-</p>
-<p class="firstline">Returns the ads Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.advertiserGroups.html">advertiserGroups()</a></code>
-</p>
-<p class="firstline">Returns the advertiserGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.advertisers.html">advertisers()</a></code>
-</p>
-<p class="firstline">Returns the advertisers Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.browsers.html">browsers()</a></code>
-</p>
-<p class="firstline">Returns the browsers Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.campaignCreativeAssociations.html">campaignCreativeAssociations()</a></code>
-</p>
-<p class="firstline">Returns the campaignCreativeAssociations Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.campaigns.html">campaigns()</a></code>
-</p>
-<p class="firstline">Returns the campaigns Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.changeLogs.html">changeLogs()</a></code>
-</p>
-<p class="firstline">Returns the changeLogs Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.cities.html">cities()</a></code>
-</p>
-<p class="firstline">Returns the cities Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.connectionTypes.html">connectionTypes()</a></code>
-</p>
-<p class="firstline">Returns the connectionTypes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.contentCategories.html">contentCategories()</a></code>
-</p>
-<p class="firstline">Returns the contentCategories Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.countries.html">countries()</a></code>
-</p>
-<p class="firstline">Returns the countries Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.creativeAssets.html">creativeAssets()</a></code>
-</p>
-<p class="firstline">Returns the creativeAssets Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.creativeFieldValues.html">creativeFieldValues()</a></code>
-</p>
-<p class="firstline">Returns the creativeFieldValues Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.creativeFields.html">creativeFields()</a></code>
-</p>
-<p class="firstline">Returns the creativeFields Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.creativeGroups.html">creativeGroups()</a></code>
-</p>
-<p class="firstline">Returns the creativeGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.creatives.html">creatives()</a></code>
-</p>
-<p class="firstline">Returns the creatives Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.dimensionValues.html">dimensionValues()</a></code>
-</p>
-<p class="firstline">Returns the dimensionValues Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.directorySiteContacts.html">directorySiteContacts()</a></code>
-</p>
-<p class="firstline">Returns the directorySiteContacts Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.directorySites.html">directorySites()</a></code>
-</p>
-<p class="firstline">Returns the directorySites Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.eventTags.html">eventTags()</a></code>
-</p>
-<p class="firstline">Returns the eventTags Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.files.html">files()</a></code>
-</p>
-<p class="firstline">Returns the files Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.floodlightActivities.html">floodlightActivities()</a></code>
-</p>
-<p class="firstline">Returns the floodlightActivities Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.floodlightActivityGroups.html">floodlightActivityGroups()</a></code>
-</p>
-<p class="firstline">Returns the floodlightActivityGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.floodlightConfigurations.html">floodlightConfigurations()</a></code>
-</p>
-<p class="firstline">Returns the floodlightConfigurations Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.inventoryItems.html">inventoryItems()</a></code>
-</p>
-<p class="firstline">Returns the inventoryItems Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.landingPages.html">landingPages()</a></code>
-</p>
-<p class="firstline">Returns the landingPages Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.metros.html">metros()</a></code>
-</p>
-<p class="firstline">Returns the metros Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.mobileCarriers.html">mobileCarriers()</a></code>
-</p>
-<p class="firstline">Returns the mobileCarriers Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.operatingSystemVersions.html">operatingSystemVersions()</a></code>
-</p>
-<p class="firstline">Returns the operatingSystemVersions Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.operatingSystems.html">operatingSystems()</a></code>
-</p>
-<p class="firstline">Returns the operatingSystems Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.orderDocuments.html">orderDocuments()</a></code>
-</p>
-<p class="firstline">Returns the orderDocuments Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.orders.html">orders()</a></code>
-</p>
-<p class="firstline">Returns the orders Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.placementGroups.html">placementGroups()</a></code>
-</p>
-<p class="firstline">Returns the placementGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.placementStrategies.html">placementStrategies()</a></code>
-</p>
-<p class="firstline">Returns the placementStrategies Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.placements.html">placements()</a></code>
-</p>
-<p class="firstline">Returns the placements Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.platformTypes.html">platformTypes()</a></code>
-</p>
-<p class="firstline">Returns the platformTypes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.postalCodes.html">postalCodes()</a></code>
-</p>
-<p class="firstline">Returns the postalCodes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.projects.html">projects()</a></code>
-</p>
-<p class="firstline">Returns the projects Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.regions.html">regions()</a></code>
-</p>
-<p class="firstline">Returns the regions Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.remarketingListShares.html">remarketingListShares()</a></code>
-</p>
-<p class="firstline">Returns the remarketingListShares Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.remarketingLists.html">remarketingLists()</a></code>
-</p>
-<p class="firstline">Returns the remarketingLists Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.reports.html">reports()</a></code>
-</p>
-<p class="firstline">Returns the reports Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.sites.html">sites()</a></code>
-</p>
-<p class="firstline">Returns the sites Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.sizes.html">sizes()</a></code>
-</p>
-<p class="firstline">Returns the sizes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.subaccounts.html">subaccounts()</a></code>
-</p>
-<p class="firstline">Returns the subaccounts Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.targetableRemarketingLists.html">targetableRemarketingLists()</a></code>
-</p>
-<p class="firstline">Returns the targetableRemarketingLists Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.userProfiles.html">userProfiles()</a></code>
-</p>
-<p class="firstline">Returns the userProfiles Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.userRolePermissionGroups.html">userRolePermissionGroups()</a></code>
-</p>
-<p class="firstline">Returns the userRolePermissionGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.userRolePermissions.html">userRolePermissions()</a></code>
-</p>
-<p class="firstline">Returns the userRolePermissions Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.userRoles.html">userRoles()</a></code>
-</p>
-<p class="firstline">Returns the userRoles Resource.</p>
-
-<p class="toc_element">
- <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
-<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
- <pre>Create a BatchHttpRequest object based on the discovery document.
-
- Args:
- callback: callable, A callback to be called for each response, of the
- form callback(id, response, exception). The first parameter is the
- request id, and the second is the deserialized response object. The
- third is an apiclient.errors.HttpError exception object if an HTTP
- error occurred while processing the request, or None if no error
- occurred.
-
- Returns:
- A BatchHttpRequest object based on the discovery document.
- </pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.operatingSystemVersions.html b/docs/dyn/dfareporting_v2_1.operatingSystemVersions.html
deleted file mode 100644
index 4963c6c..0000000
--- a/docs/dyn/dfareporting_v2_1.operatingSystemVersions.html
+++ /dev/null
@@ -1,142 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.operatingSystemVersions.html">operatingSystemVersions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one operating system version by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of operating system versions.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one operating system version by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Operating system version ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of operating system versions.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Operating System Version List Response
- "kind": "dfareporting#operatingSystemVersionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse".
- "operatingSystemVersions": [ # Operating system version collection.
- { # Contains information about a particular version of an operating system that can be targeted by ads.
- "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
- "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
- "name": "A String", # Name of this operating system version.
- "id": "A String", # ID of this operating system version.
- "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.orderDocuments.html b/docs/dyn/dfareporting_v2_1.orderDocuments.html
deleted file mode 100644
index eba644d..0000000
--- a/docs/dyn/dfareporting_v2_1.orderDocuments.html
+++ /dev/null
@@ -1,191 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.orderDocuments.html">orderDocuments</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, projectId, id)</a></code></p>
-<p class="firstline">Gets one order document by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, projectId, pageToken=None, sortOrder=None, orderId=None, maxResults=None, siteId=None, approved=None, searchString=None, sortField=None, ids=None)</a></code></p>
-<p class="firstline">Retrieves a list of order documents, possibly filtered.</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(profileId, projectId, id)</code>
- <pre>Gets one order document by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- projectId: string, Project ID for order documents. (required)
- id: string, Order document ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DoubleClick Planning order document.
- "orderId": "A String", # ID of the order from which this order document is created.
- "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
- "A String",
- ],
- "kind": "dfareporting#orderDocument", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
- "subaccountId": "A String", # Subaccount ID of this order document.
- "effectiveDate": "A String", # Effective date of this order document.
- "title": "A String", # Title of this order document.
- "projectId": "A String", # Project ID of this order document.
- "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
- "signed": True or False, # Whether this order document has been signed.
- "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "advertiserId": "A String", # Advertiser ID of this order document.
- "cancelled": True or False, # Whether this order document is cancelled.
- "type": "A String", # Type of this order document
- "id": "A String", # ID of this order document.
- "accountId": "A String", # Account ID of this order document.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, projectId, pageToken=None, sortOrder=None, orderId=None, maxResults=None, siteId=None, approved=None, searchString=None, sortField=None, ids=None)</code>
- <pre>Retrieves a list of order documents, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- projectId: string, Project ID for order documents. (required)
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- orderId: string, Select only order documents for specified orders. (repeated)
- maxResults: integer, Maximum number of results to return.
- siteId: string, Select only order documents that are associated with these sites. (repeated)
- approved: boolean, Select only order documents that have been approved by at least one user.
- searchString: string, Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only order documents with these IDs. (repeated)
-
-Returns:
- An object of the form:
-
- { # Order document List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#orderDocumentsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse".
- "orderDocuments": [ # Order document collection
- { # Contains properties of a DoubleClick Planning order document.
- "orderId": "A String", # ID of the order from which this order document is created.
- "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
- "A String",
- ],
- "kind": "dfareporting#orderDocument", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
- "subaccountId": "A String", # Subaccount ID of this order document.
- "effectiveDate": "A String", # Effective date of this order document.
- "title": "A String", # Title of this order document.
- "projectId": "A String", # Project ID of this order document.
- "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
- "signed": True or False, # Whether this order document has been signed.
- "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "advertiserId": "A String", # Advertiser ID of this order document.
- "cancelled": True or False, # Whether this order document is cancelled.
- "type": "A String", # Type of this order document
- "id": "A String", # ID of this order document.
- "accountId": "A String", # Account ID of this order document.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.orders.html b/docs/dyn/dfareporting_v2_1.orders.html
deleted file mode 100644
index 26f1d70..0000000
--- a/docs/dyn/dfareporting_v2_1.orders.html
+++ /dev/null
@@ -1,223 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.orders.html">orders</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, projectId, id)</a></code></p>
-<p class="firstline">Gets one order by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, projectId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None, siteId=None)</a></code></p>
-<p class="firstline">Retrieves a list of orders, possibly filtered.</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(profileId, projectId, id)</code>
- <pre>Gets one order by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- projectId: string, Project ID for orders. (required)
- id: string, Order ID. (required)
-
-Returns:
- An object of the form:
-
- { # Describes properties of a DoubleClick Planning order.
- "termsAndConditions": "A String", # Terms and conditions of this order.
- "kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
- "sellerOrganizationName": "A String", # Name of the seller organization.
- "subaccountId": "A String", # Subaccount ID of this order.
- "name": "A String", # Name of this order.
- "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "notes": "A String", # Notes of this order.
- "contacts": [ # Contacts for this order.
- { # Contact of an order.
- "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
- "contactTitle": "A String", # Title of this contact.
- "contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
- "contactName": "A String", # Name of this contact.
- "contactType": "A String", # Type of this contact.
- },
- ],
- "buyerOrganizationName": "A String", # Name of the buyer organization.
- "comments": "A String", # Comments in this order.
- "advertiserId": "A String", # Advertiser ID of this order.
- "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
- "A String",
- ],
- "siteId": [ # Site IDs this order is associated with.
- "A String",
- ],
- "sellerOrderId": "A String", # Seller order ID associated with this order.
- "projectId": "A String", # Project ID of this order.
- "siteNames": [ # Free-form site names this order is associated with.
- "A String",
- ],
- "planningTermId": "A String", # ID of the terms and conditions template used in this order.
- "id": "A String", # ID of this order. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this order.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, projectId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None, siteId=None)</code>
- <pre>Retrieves a list of orders, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- projectId: string, Project ID for orders. (required)
- searchString: string, Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only orders with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- siteId: string, Select only orders that are associated with these site IDs. (repeated)
-
-Returns:
- An object of the form:
-
- { # Order List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse".
- "orders": [ # Order collection.
- { # Describes properties of a DoubleClick Planning order.
- "termsAndConditions": "A String", # Terms and conditions of this order.
- "kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
- "sellerOrganizationName": "A String", # Name of the seller organization.
- "subaccountId": "A String", # Subaccount ID of this order.
- "name": "A String", # Name of this order.
- "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "notes": "A String", # Notes of this order.
- "contacts": [ # Contacts for this order.
- { # Contact of an order.
- "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
- "contactTitle": "A String", # Title of this contact.
- "contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
- "contactName": "A String", # Name of this contact.
- "contactType": "A String", # Type of this contact.
- },
- ],
- "buyerOrganizationName": "A String", # Name of the buyer organization.
- "comments": "A String", # Comments in this order.
- "advertiserId": "A String", # Advertiser ID of this order.
- "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
- "A String",
- ],
- "siteId": [ # Site IDs this order is associated with.
- "A String",
- ],
- "sellerOrderId": "A String", # Seller order ID associated with this order.
- "projectId": "A String", # Project ID of this order.
- "siteNames": [ # Free-form site names this order is associated with.
- "A String",
- ],
- "planningTermId": "A String", # ID of the terms and conditions template used in this order.
- "id": "A String", # ID of this order. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this order.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.placementGroups.html b/docs/dyn/dfareporting_v2_1.placementGroups.html
deleted file mode 100644
index 9b7e243..0000000
--- a/docs/dyn/dfareporting_v2_1.placementGroups.html
+++ /dev/null
@@ -1,1068 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.placementGroups.html">placementGroups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one placement group by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new placement group.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, sortOrder=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, searchString=None, directorySiteIds=None, ids=None, sortField=None)</a></code></p>
-<p class="firstline">Retrieves a list of placement groups, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing placement group. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing placement group.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one placement group by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement group ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new placement group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, sortOrder=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, searchString=None, directorySiteIds=None, ids=None, sortField=None)</code>
- <pre>Retrieves a list of placement groups, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- siteIds: string, Select only placement groups that are associated with these sites. (repeated)
- placementGroupType: string, Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.
- Allowed values
- PLACEMENT_PACKAGE -
- PLACEMENT_ROADBLOCK -
- pricingTypes: string, Select only placement groups with these pricing types. (repeated)
- Allowed values
- PRICING_TYPE_CPA -
- PRICING_TYPE_CPC -
- PRICING_TYPE_CPM -
- PRICING_TYPE_FLAT_RATE_CLICKS -
- PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
- campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
- advertiserIds: string, Select only placement groups that belong to these advertisers. (repeated)
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- placementStrategyIds: string, Select only placement groups that are associated with these placement strategies. (repeated)
- contentCategoryIds: string, Select only placement groups that are associated with these content categories. (repeated)
- archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
- maxResults: integer, Maximum number of results to return.
- searchString: string, Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".
- directorySiteIds: string, Select only placement groups that are associated with these directory sites. (repeated)
- ids: string, Select only placement groups with these IDs. (repeated)
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
-
-Returns:
- An object of the form:
-
- { # Placement Group List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#placementGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse".
- "placementGroups": [ # Placement group collection.
- { # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing placement group. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement group ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing placement group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a package or roadblock.
- "comment": "A String", # Comments for this placement group.
- "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
- "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
- "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
- "programmaticSetting": { # Programmatic Setting # Settings for a programmatic placement.
- "traffickerEmails": [ # Trafficker emails assigned to the placement.
- "A String",
- ],
- "programmatic": True or False, # Whether programmatic is enabled.
- "insertionOrderId": "A String", # Insertion order ID.
- "insertionOrderIdStatus": True or False, # Whether insertion order ID has been placed in DFP. This is a read-only field.
- "adxDealIds": [ # Adx deal IDs assigned to the placement.
- "A String",
- ],
- "mediaCostNanos": "A String", # Media cost for the programmatic placement.
- },
- "archived": True or False, # Whether this placement group is archived.
- "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
- "A String",
- ],
- "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
- "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
- "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.placements.html b/docs/dyn/dfareporting_v2_1.placements.html
deleted file mode 100644
index 8b79450..0000000
--- a/docs/dyn/dfareporting_v2_1.placements.html
+++ /dev/null
@@ -1,1350 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.placements.html">placements</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#generatetags">generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None)</a></code></p>
-<p class="firstline">Generates tags for a placement.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one placement by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new placement.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, sizeIds=None, advertiserIds=None, pageToken=None, sortOrder=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, compatibilities=None, searchString=None, directorySiteIds=None, ids=None, groupIds=None, sortField=None)</a></code></p>
-<p class="firstline">Retrieves a list of placements, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing placement. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing placement.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="generatetags">generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None)</code>
- <pre>Generates tags for a placement.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Generate placements belonging to this campaign. This is a required field.
- tagFormats: string, Tag formats to generate for these placements. (repeated)
- Allowed values
- PLACEMENT_TAG_CLICK_COMMANDS -
- PLACEMENT_TAG_IFRAME_ILAYER -
- PLACEMENT_TAG_IFRAME_JAVASCRIPT -
- PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH -
- PLACEMENT_TAG_INTERNAL_REDIRECT -
- PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT -
- PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT -
- PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT -
- PLACEMENT_TAG_JAVASCRIPT -
- PLACEMENT_TAG_STANDARD -
- PLACEMENT_TAG_TRACKING -
- PLACEMENT_TAG_TRACKING_IFRAME -
- PLACEMENT_TAG_TRACKING_JAVASCRIPT -
- placementIds: string, Generate tags for these placements. (repeated)
-
-Returns:
- An object of the form:
-
- { # Placement GenerateTags Response
- "kind": "dfareporting#placementsGenerateTagsResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse".
- "placementTags": [ # Set of generated tags for the specified placements.
- { # Placement Tag
- "tagDatas": [ # Tags generated for this placement.
- { # Placement Tag Data
- "clickTag": "A String", # Tag string to record a click.
- "impressionTag": "A String", # Tag string for serving an ad.
- "creativeId": "A String", # Creative associated with this placement tag.
- "adId": "A String", # Ad associated with this placement tag.
- "format": "A String", # TagData tag format of this tag.
- },
- ],
- "placementId": "A String", # Placement ID
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one placement by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new placement.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, sizeIds=None, advertiserIds=None, pageToken=None, sortOrder=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, compatibilities=None, searchString=None, directorySiteIds=None, ids=None, groupIds=None, sortField=None)</code>
- <pre>Retrieves a list of placements, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- siteIds: string, Select only placements that are associated with these sites. (repeated)
- paymentSource: string, Select only placements with this payment source.
- Allowed values
- PLACEMENT_AGENCY_PAID -
- PLACEMENT_PUBLISHER_PAID -
- pricingTypes: string, Select only placements with these pricing types. (repeated)
- Allowed values
- PRICING_TYPE_CPA -
- PRICING_TYPE_CPC -
- PRICING_TYPE_CPM -
- PRICING_TYPE_FLAT_RATE_CLICKS -
- PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
- campaignIds: string, Select only placements that belong to these campaigns. (repeated)
- sizeIds: string, Select only placements that are associated with these sizes. (repeated)
- advertiserIds: string, Select only placements that belong to these advertisers. (repeated)
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated)
- contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated)
- archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
- maxResults: integer, Maximum number of results to return.
- compatibilities: string, Select only placements that are associated with these compatibilities. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. (repeated)
- Allowed values
- APP -
- APP_INTERSTITIAL -
- IN_STREAM_VIDEO -
- WEB -
- WEB_INTERSTITIAL -
- searchString: string, Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement".
- directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated)
- ids: string, Select only placements with these IDs. (repeated)
- groupIds: string, Select only placements that belong to these placement groups. (repeated)
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
-
-Returns:
- An object of the form:
-
- { # Placement List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#placementsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse".
- "placements": [ # Placement collection.
- { # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing placement. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing placement.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement.
- "comment": "A String", # Comments for this placement.
- "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
- "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
- "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this placement. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this placement. This field can be left blank.
- "archived": True or False, # Whether this placement is archived.
- "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
- # Acceptable values are:
- # - "PLACEMENT_TAG_STANDARD"
- # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_IFRAME_ILAYER"
- # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
- # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
- # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
- # - "PLACEMENT_TAG_CLICK_COMMANDS"
- # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
- # - "PLACEMENT_TAG_TRACKING"
- # - "PLACEMENT_TAG_TRACKING_IFRAME"
- # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
- "A String",
- ],
- "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
- "tagSetting": { # Tag Settings # Tag settings for this placement.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "contentCategoryId": "A String", # ID of the content category assigned to this placement.
- "externalId": "A String", # External ID for this placement.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
- "status": "A String", # Third-party placement status.
- "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
- "placementGroupId": "A String", # ID of this placement's group, if applicable.
- "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
- "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
- "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
- "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
- "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
- "startDate": "A String", # Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
- "endDate": "A String", # Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
- "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
- "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
- "capCostOption": "A String", # Placement cap cost option.
- "pricingPeriods": [ # Pricing periods for this placement.
- { # Pricing Period
- "units": "A String", # Units of this pricing period.
- "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
- "startDate": "A String", # Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "endDate": "A String", # Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
- "pricingComment": "A String", # Comments for this pricing period.
- },
- ],
- "pricingType": "A String", # Placement pricing type. This field is required on insertion.
- "testingStartDate": "A String", # Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
- },
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.postalCodes.html b/docs/dyn/dfareporting_v2_1.postalCodes.html
deleted file mode 100644
index fb2fb2b..0000000
--- a/docs/dyn/dfareporting_v2_1.postalCodes.html
+++ /dev/null
@@ -1,128 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.postalCodes.html">postalCodes</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, code)</a></code></p>
-<p class="firstline">Gets one postal code by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of postal codes.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, code)</code>
- <pre>Gets one postal code by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- code: string, Postal code ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains information about a postal code that can be targeted by ads.
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "code": "A String", # Postal code. This is equivalent to the id field.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of postal codes.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Postal Code List Response
- "kind": "dfareporting#postalCodesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse".
- "postalCodes": [ # Postal code collection.
- { # Contains information about a postal code that can be targeted by ads.
- "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
- "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
- "code": "A String", # Postal code. This is equivalent to the id field.
- "id": "A String", # ID of this postal code.
- "countryCode": "A String", # Country code of the country to which this postal code belongs.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.regions.html b/docs/dyn/dfareporting_v2_1.regions.html
deleted file mode 100644
index b0e9f5d..0000000
--- a/docs/dyn/dfareporting_v2_1.regions.html
+++ /dev/null
@@ -1,106 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.regions.html">regions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of regions.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of regions.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Region List Response
- "regions": [ # Region collection.
- { # Contains information about a region that can be targeted by ads.
- "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
- "countryDartId": "A String", # DART ID of the country to which this region belongs.
- "name": "A String", # Name of this region.
- "countryCode": "A String", # Country code of the country to which this region belongs.
- "regionCode": "A String", # Region code.
- "dartId": "A String", # DART ID of this region.
- },
- ],
- "kind": "dfareporting#regionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse".
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.remarketingLists.html b/docs/dyn/dfareporting_v2_1.remarketingLists.html
deleted file mode 100644
index 6c2462b..0000000
--- a/docs/dyn/dfareporting_v2_1.remarketingLists.html
+++ /dev/null
@@ -1,532 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.remarketingLists.html">remarketingLists</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one remarketing list by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new remarketing list.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of remarketing lists, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing remarketing list. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing remarketing list.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one remarketing list by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Remarketing list ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingList resource.
- "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
- "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
- "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
- { # A group clause made up of list population terms representing constraints joined by ORs.
- "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
- { # Remarketing List Population Rule Term.
- "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
- "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
- "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
- "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
- "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- },
- ],
- },
- ],
- },
- "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
- "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- "description": "A String", # Remarketing list description.
- "listSize": "A String", # Number of users currently in the list. This is a read-only field.
- "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
- "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
- "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
- "listSource": "A String", # Product from which this remarketing list was originated.
- "active": True or False, # Whether this remarketing list is active.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new remarketing list.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingList resource.
- "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
- "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
- "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
- { # A group clause made up of list population terms representing constraints joined by ORs.
- "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
- { # Remarketing List Population Rule Term.
- "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
- "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
- "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
- "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
- "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- },
- ],
- },
- ],
- },
- "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
- "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- "description": "A String", # Remarketing list description.
- "listSize": "A String", # Number of users currently in the list. This is a read-only field.
- "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
- "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
- "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
- "listSource": "A String", # Product from which this remarketing list was originated.
- "active": True or False, # Whether this remarketing list is active.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingList resource.
- "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
- "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
- "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
- { # A group clause made up of list population terms representing constraints joined by ORs.
- "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
- { # Remarketing List Population Rule Term.
- "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
- "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
- "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
- "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
- "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- },
- ],
- },
- ],
- },
- "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
- "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- "description": "A String", # Remarketing list description.
- "listSize": "A String", # Number of users currently in the list. This is a read-only field.
- "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
- "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
- "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
- "listSource": "A String", # Product from which this remarketing list was originated.
- "active": True or False, # Whether this remarketing list is active.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None)</code>
- <pre>Retrieves a list of remarketing lists, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- advertiserId: string, Select only remarketing lists owned by this advertiser. (required)
- name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- floodlightActivityId: string, Select only remarketing lists that have this floodlight activity ID.
- maxResults: integer, Maximum number of results to return.
- active: boolean, Select only active or only inactive remarketing lists.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Remarketing list response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "remarketingLists": [ # Remarketing list collection.
- { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingList resource.
- "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
- "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
- "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
- { # A group clause made up of list population terms representing constraints joined by ORs.
- "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
- { # Remarketing List Population Rule Term.
- "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
- "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
- "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
- "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
- "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- },
- ],
- },
- ],
- },
- "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
- "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- "description": "A String", # Remarketing list description.
- "listSize": "A String", # Number of users currently in the list. This is a read-only field.
- "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
- "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
- "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
- "listSource": "A String", # Product from which this remarketing list was originated.
- "active": True or False, # Whether this remarketing list is active.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- },
- ],
- "kind": "dfareporting#remarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse".
- }</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(profileId, id, body)</code>
- <pre>Updates an existing remarketing list. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Remarketing list ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingList resource.
- "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
- "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
- "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
- { # A group clause made up of list population terms representing constraints joined by ORs.
- "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
- { # Remarketing List Population Rule Term.
- "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
- "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
- "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
- "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
- "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- },
- ],
- },
- ],
- },
- "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
- "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- "description": "A String", # Remarketing list description.
- "listSize": "A String", # Number of users currently in the list. This is a read-only field.
- "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
- "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
- "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
- "listSource": "A String", # Product from which this remarketing list was originated.
- "active": True or False, # Whether this remarketing list is active.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingList resource.
- "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
- "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
- "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
- { # A group clause made up of list population terms representing constraints joined by ORs.
- "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
- { # Remarketing List Population Rule Term.
- "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
- "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
- "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
- "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
- "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- },
- ],
- },
- ],
- },
- "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
- "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- "description": "A String", # Remarketing list description.
- "listSize": "A String", # Number of users currently in the list. This is a read-only field.
- "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
- "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
- "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
- "listSource": "A String", # Product from which this remarketing list was originated.
- "active": True or False, # Whether this remarketing list is active.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing remarketing list.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingList resource.
- "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
- "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
- "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
- { # A group clause made up of list population terms representing constraints joined by ORs.
- "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
- { # Remarketing List Population Rule Term.
- "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
- "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
- "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
- "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
- "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- },
- ],
- },
- ],
- },
- "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
- "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- "description": "A String", # Remarketing list description.
- "listSize": "A String", # Number of users currently in the list. This is a read-only field.
- "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
- "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
- "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
- "listSource": "A String", # Product from which this remarketing list was originated.
- "active": True or False, # Whether this remarketing list is active.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingList resource.
- "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
- "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
- "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
- "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
- { # A group clause made up of list population terms representing constraints joined by ORs.
- "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
- { # Remarketing List Population Rule Term.
- "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
- "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
- "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
- "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
- "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
- },
- ],
- },
- ],
- },
- "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
- "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- "description": "A String", # Remarketing list description.
- "listSize": "A String", # Number of users currently in the list. This is a read-only field.
- "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
- "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
- "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
- "listSource": "A String", # Product from which this remarketing list was originated.
- "active": True or False, # Whether this remarketing list is active.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Remarketing list ID. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.reports.compatibleFields.html b/docs/dyn/dfareporting_v2_1.reports.compatibleFields.html
deleted file mode 100644
index f35e447..0000000
--- a/docs/dyn/dfareporting_v2_1.reports.compatibleFields.html
+++ /dev/null
@@ -1,551 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.reports.html">reports</a> . <a href="dfareporting_v2_1.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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.reports.files.html b/docs/dyn/dfareporting_v2_1.reports.files.html
deleted file mode 100644
index e649452..0000000
--- a/docs/dyn/dfareporting_v2_1.reports.files.html
+++ /dev/null
@@ -1,203 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.reports.html">reports</a> . <a href="dfareporting_v2_1.reports.files.html">files</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, reportId, fileId)</a></code></p>
-<p class="firstline">Retrieves a report file.</p>
-<p class="toc_element">
- <code><a href="#get_media">get_media(profileId, reportId, fileId)</a></code></p>
-<p class="firstline">Retrieves a report file.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Lists files for a report.</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(profileId, reportId, fileId)</code>
- <pre>Retrieves a report file.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- 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 metadata 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.
- "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.
- },
- "fileName": "A String", # The filename 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(profileId, reportId, fileId)</code>
- <pre>Retrieves a report file.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- 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, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)</code>
- <pre>Lists files for a report.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the parent report. (required)
- pageToken: string, The value of the nextToken from the previous result page.
- sortField: string, The field by which to sort the list.
- Allowed values
- ID - Sort by file ID.
- LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
- 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.
-
-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 metadata 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.
- "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.
- },
- "fileName": "A String", # The filename 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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.reports.html b/docs/dyn/dfareporting_v2_1.reports.html
deleted file mode 100644
index 753e53b..0000000
--- a/docs/dyn/dfareporting_v2_1.reports.html
+++ /dev/null
@@ -1,2795 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.reports.html">reports</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.reports.compatibleFields.html">compatibleFields()</a></code>
-</p>
-<p class="firstline">Returns the compatibleFields Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_1.reports.files.html">files()</a></code>
-</p>
-<p class="firstline">Returns the files Resource.</p>
-
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, reportId)</a></code></p>
-<p class="firstline">Deletes a report by its ID.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, reportId)</a></code></p>
-<p class="firstline">Retrieves a report by its ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Creates a report.</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">Retrieves list of reports.</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(profileId, reportId, body)</a></code></p>
-<p class="firstline">Updates a report. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#run">run(profileId, reportId, synchronous=None)</a></code></p>
-<p class="firstline">Runs a report.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, reportId, body)</a></code></p>
-<p class="firstline">Updates a report.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, reportId)</code>
- <pre>Deletes a report by its ID.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, reportId)</code>
- <pre>Retrieves a report by its ID.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
-
-Returns:
- An object of the form:
-
- { # 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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Creates a report.
-
-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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # 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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)</code>
- <pre>Retrieves list of reports.
-
-Args:
- profileId: string, The DFA user 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 report ID.
- LAST_MODIFIED_TIME - Sort by 'lastModifiedTime' field.
- NAME - Sort by name of reports.
- scope: string, The scope that defines which results are returned, default is 'MINE'.
- Allowed values
- ALL - All reports in account.
- MINE - My reports.
-
-Returns:
- An object of the form:
-
- { # Represents the list of reports.
- "nextPageToken": "A String", # Continuation token used to page through reports. 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 reports returned in this response.
- { # 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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- },
- ],
- "kind": "dfareporting#reportList", # The kind of list this is, in this case dfareporting#reportList.
- "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>
-
-<div class="method">
- <code class="details" id="patch">patch(profileId, reportId, body)</code>
- <pre>Updates a report. This method supports patch semantics.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # 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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="run">run(profileId, reportId, synchronous=None)</code>
- <pre>Runs a report.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the report. (required)
- synchronous: boolean, If set and true, tries to run the report synchronously.
-
-Returns:
- An object of the form:
-
- { # Represents a File resource. A file contains the metadata 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.
- "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.
- },
- "fileName": "A String", # The filename 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="update">update(profileId, reportId, body)</code>
- <pre>Updates a report.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # 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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.sizes.html b/docs/dyn/dfareporting_v2_1.sizes.html
deleted file mode 100644
index 4c01d7e..0000000
--- a/docs/dyn/dfareporting_v2_1.sizes.html
+++ /dev/null
@@ -1,165 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.sizes.html">sizes</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one size by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new size.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, iabStandard=None, width=None, ids=None, height=None)</a></code></p>
-<p class="firstline">Retrieves a list of sizes, possibly filtered.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one size by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Size ID. (required)
-
-Returns:
- An object of the form:
-
- { # Represents the dimensions of ads, placements, creatives, or creative assets.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new size.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents the dimensions of ads, placements, creatives, or creative assets.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
-}
-
-
-Returns:
- An object of the form:
-
- { # Represents the dimensions of ads, placements, creatives, or creative assets.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, iabStandard=None, width=None, ids=None, height=None)</code>
- <pre>Retrieves a list of sizes, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- iabStandard: boolean, Select only IAB standard sizes.
- width: integer, Select only sizes with this width.
- ids: string, Select only sizes with these IDs. (repeated)
- height: integer, Select only sizes with this height.
-
-Returns:
- An object of the form:
-
- { # Size List Response
- "kind": "dfareporting#sizesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse".
- "sizes": [ # Size collection.
- { # Represents the dimensions of ads, placements, creatives, or creative assets.
- "width": 42, # Width of this size.
- "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
- "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
- "id": "A String", # ID of this size. This is a read-only, auto-generated field.
- "height": 42, # Height of this size.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.subaccounts.html b/docs/dyn/dfareporting_v2_1.subaccounts.html
deleted file mode 100644
index f6268ea..0000000
--- a/docs/dyn/dfareporting_v2_1.subaccounts.html
+++ /dev/null
@@ -1,274 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.subaccounts.html">subaccounts</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one subaccount by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new subaccount.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Gets a list of subaccounts, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing subaccount. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing subaccount.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one subaccount by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Subaccount ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new subaccount.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Gets a list of subaccounts, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only subaccounts with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Subaccount List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#subaccountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse".
- "subaccounts": [ # Subaccount collection.
- { # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing subaccount. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Subaccount ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing subaccount.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM subaccount.
- "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
- "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
- "A String",
- ],
- "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
- "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
- "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.targetableRemarketingLists.html b/docs/dyn/dfareporting_v2_1.targetableRemarketingLists.html
deleted file mode 100644
index 9e2dc9d..0000000
--- a/docs/dyn/dfareporting_v2_1.targetableRemarketingLists.html
+++ /dev/null
@@ -1,187 +0,0 @@
-<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_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.targetableRemarketingLists.html">targetableRemarketingLists</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one remarketing list by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of targetable remarketing lists, possibly filtered.</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(profileId, id)</code>
- <pre>Gets one remarketing list by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Remarketing list ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingList resource.
- "kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
- "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- "description": "A String", # Targetable remarketing list description.
- "listSize": "A String", # Number of users currently in the list. This is a read-only field.
- "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
- "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
- "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
- "listSource": "A String", # Product from which this targetable remarketing list was originated.
- "active": True or False, # Whether this targetable remarketing list is active.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Targetable remarketing list ID.
- "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None)</code>
- <pre>Retrieves a list of targetable remarketing lists, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- advertiserId: string, Select only targetable remarketing lists targetable by these advertisers. (required)
- name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- maxResults: integer, Maximum number of results to return.
- active: boolean, Select only active or only inactive targetable remarketing lists.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Targetable remarketing list response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#targetableRemarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse".
- "targetableRemarketingLists": [ # Targetable remarketing list collection.
- { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingList resource.
- "kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
- "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- "description": "A String", # Targetable remarketing list description.
- "listSize": "A String", # Number of users currently in the list. This is a read-only field.
- "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
- "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
- "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
- "listSource": "A String", # Product from which this targetable remarketing list was originated.
- "active": True or False, # Whether this targetable remarketing list is active.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # Targetable remarketing list ID.
- "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.accountActiveAdSummaries.html b/docs/dyn/dfareporting_v2_2.accountActiveAdSummaries.html
deleted file mode 100644
index cac7c81..0000000
--- a/docs/dyn/dfareporting_v2_2.accountActiveAdSummaries.html
+++ /dev/null
@@ -1,101 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.accountActiveAdSummaries.html">accountActiveAdSummaries</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, summaryAccountId)</a></code></p>
-<p class="firstline">Gets the account's active ad summary by account ID.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, summaryAccountId)</code>
- <pre>Gets the account's active ad summary by account ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- summaryAccountId: string, Account ID. (required)
-
-Returns:
- An object of the form:
-
- { # Gets a summary of active ads in an account.
- "availableAds": "A String", # Ads that can be activated for the account.
- "kind": "dfareporting#accountActiveAdSummary", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary".
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for the account.
- "activeAds": "A String", # Ads that have been activated for the account
- "accountId": "A String", # ID of the account.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.accountPermissionGroups.html b/docs/dyn/dfareporting_v2_2.accountPermissionGroups.html
deleted file mode 100644
index 4bbbb88..0000000
--- a/docs/dyn/dfareporting_v2_2.accountPermissionGroups.html
+++ /dev/null
@@ -1,124 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.accountPermissionGroups.html">accountPermissionGroups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one account permission group by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves the list of account permission groups.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one account permission group by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Account permission group ID. (required)
-
-Returns:
- An object of the form:
-
- { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
- "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
- "id": "A String", # ID of this account permission group.
- "name": "A String", # Name of this account permission group.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves the list of account permission groups.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Account Permission Group List Response
- "kind": "dfareporting#accountPermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse".
- "accountPermissionGroups": [ # Account permission group collection.
- { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
- "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
- "id": "A String", # ID of this account permission group.
- "name": "A String", # Name of this account permission group.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.accountUserProfiles.html b/docs/dyn/dfareporting_v2_2.accountUserProfiles.html
deleted file mode 100644
index 840481a..0000000
--- a/docs/dyn/dfareporting_v2_2.accountUserProfiles.html
+++ /dev/null
@@ -1,677 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.accountUserProfiles.html">accountUserProfiles</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one account user profile by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new account user profile.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None)</a></code></p>
-<p class="firstline">Retrieves a list of account user profiles, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing account user profile. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing account user profile.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one account user profile by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User profile ID. (required)
-
-Returns:
- An object of the form:
-
- { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new account user profile.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None)</code>
- <pre>Retrieves a list of account user profiles, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".
- subaccountId: string, Select only user profiles with the specified subaccount ID.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only user profiles with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- userRoleId: string, Select only user profiles with the specified user role ID.
- active: boolean, Select only active user profiles.
-
-Returns:
- An object of the form:
-
- { # Account User Profile List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "accountUserProfiles": [ # Account user profile collection.
- { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- },
- ],
- "kind": "dfareporting#accountUserProfilesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".
- }</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(profileId, id, body)</code>
- <pre>Updates an existing account user profile. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User profile ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing account user profile.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
- "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
- "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
- "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
- "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "locale": "A String", # Locale of the user profile. This is a required field.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "comments": "A String", # Comments for this user profile.
- "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
- "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
- "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
- "A String",
- ],
- "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
- "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
- },
- "userRoleId": "A String", # User role ID of the user profile. This is a required field.
- "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
- "traffickerType": "A String", # Trafficker type of this user profile.
- "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
- "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
- "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.accounts.html b/docs/dyn/dfareporting_v2_2.accounts.html
deleted file mode 100644
index 7c36183..0000000
--- a/docs/dyn/dfareporting_v2_2.accounts.html
+++ /dev/null
@@ -1,790 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.accounts.html">accounts</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one account by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None)</a></code></p>
-<p class="firstline">Retrieves the list of accounts, possibly filtered.</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(profileId, 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(profileId, 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(profileId, id)</code>
- <pre>Gets one account by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Account ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM account.
- "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
- "countryId": "A String", # ID of the country associated with this account.
- "availablePermissionIds": [ # User role permissions available to the user roles of this account.
- "A String",
- ],
- "description": "A String", # Description of this account.
- "maximumImageSize": "A String", # Maximum image size allowed for this account.
- "currencyId": "A String", # ID of currency associated with this account. This is a required field.
- # Acceptable values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
- "accountPermissionIds": [ # Account permissions assigned to this account.
- "A String",
- ],
- "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
- "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
- "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
- "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
- "locale": "A String", # Locale of this account.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
- "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
- "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
- # Acceptable values are:
- #
- # - "1" for "America/New_York"
- # - "2" for "Europe/London"
- # - "3" for "Europe/Paris"
- # - "4" for "Africa/Johannesburg"
- # - "5" for "Asia/Jerusalem"
- # - "6" for "Asia/Shanghai"
- # - "7" for "Asia/Hong_Kong"
- # - "8" for "Asia/Tokyo"
- # - "9" for "Australia/Sydney"
- # - "10" for "Asia/Dubai"
- # - "11" for "America/Los_Angeles"
- # - "12" for "Pacific/Auckland"
- # - "13" for "America/Sao_Paulo"
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- },
- "active": True or False, # Whether this account is active.
- "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
- "id": "A String", # ID of this account. This is a read-only, auto-generated field.
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None)</code>
- <pre>Retrieves the list of accounts, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only accounts with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- active: boolean, Select only active accounts. Don't set this field to select both active and non-active accounts.
-
-Returns:
- An object of the form:
-
- { # Account List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse".
- "accounts": [ # Account collection.
- { # Contains properties of a DCM account.
- "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
- "countryId": "A String", # ID of the country associated with this account.
- "availablePermissionIds": [ # User role permissions available to the user roles of this account.
- "A String",
- ],
- "description": "A String", # Description of this account.
- "maximumImageSize": "A String", # Maximum image size allowed for this account.
- "currencyId": "A String", # ID of currency associated with this account. This is a required field.
- # Acceptable values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
- "accountPermissionIds": [ # Account permissions assigned to this account.
- "A String",
- ],
- "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
- "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
- "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
- "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
- "locale": "A String", # Locale of this account.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
- "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
- "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
- # Acceptable values are:
- #
- # - "1" for "America/New_York"
- # - "2" for "Europe/London"
- # - "3" for "Europe/Paris"
- # - "4" for "Africa/Johannesburg"
- # - "5" for "Asia/Jerusalem"
- # - "6" for "Asia/Shanghai"
- # - "7" for "Asia/Hong_Kong"
- # - "8" for "Asia/Tokyo"
- # - "9" for "Australia/Sydney"
- # - "10" for "Asia/Dubai"
- # - "11" for "America/Los_Angeles"
- # - "12" for "Pacific/Auckland"
- # - "13" for "America/Sao_Paulo"
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- },
- "active": True or False, # Whether this account is active.
- "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
- "id": "A String", # ID of this account. This is a read-only, auto-generated field.
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing account. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Account ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM account.
- "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
- "countryId": "A String", # ID of the country associated with this account.
- "availablePermissionIds": [ # User role permissions available to the user roles of this account.
- "A String",
- ],
- "description": "A String", # Description of this account.
- "maximumImageSize": "A String", # Maximum image size allowed for this account.
- "currencyId": "A String", # ID of currency associated with this account. This is a required field.
- # Acceptable values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
- "accountPermissionIds": [ # Account permissions assigned to this account.
- "A String",
- ],
- "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
- "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
- "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
- "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
- "locale": "A String", # Locale of this account.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
- "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
- "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
- # Acceptable values are:
- #
- # - "1" for "America/New_York"
- # - "2" for "Europe/London"
- # - "3" for "Europe/Paris"
- # - "4" for "Africa/Johannesburg"
- # - "5" for "Asia/Jerusalem"
- # - "6" for "Asia/Shanghai"
- # - "7" for "Asia/Hong_Kong"
- # - "8" for "Asia/Tokyo"
- # - "9" for "Australia/Sydney"
- # - "10" for "Asia/Dubai"
- # - "11" for "America/Los_Angeles"
- # - "12" for "Pacific/Auckland"
- # - "13" for "America/Sao_Paulo"
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- },
- "active": True or False, # Whether this account is active.
- "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
- "id": "A String", # ID of this account. This is a read-only, auto-generated field.
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM account.
- "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
- "countryId": "A String", # ID of the country associated with this account.
- "availablePermissionIds": [ # User role permissions available to the user roles of this account.
- "A String",
- ],
- "description": "A String", # Description of this account.
- "maximumImageSize": "A String", # Maximum image size allowed for this account.
- "currencyId": "A String", # ID of currency associated with this account. This is a required field.
- # Acceptable values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
- "accountPermissionIds": [ # Account permissions assigned to this account.
- "A String",
- ],
- "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
- "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
- "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
- "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
- "locale": "A String", # Locale of this account.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
- "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
- "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
- # Acceptable values are:
- #
- # - "1" for "America/New_York"
- # - "2" for "Europe/London"
- # - "3" for "Europe/Paris"
- # - "4" for "Africa/Johannesburg"
- # - "5" for "Asia/Jerusalem"
- # - "6" for "Asia/Shanghai"
- # - "7" for "Asia/Hong_Kong"
- # - "8" for "Asia/Tokyo"
- # - "9" for "Australia/Sydney"
- # - "10" for "Asia/Dubai"
- # - "11" for "America/Los_Angeles"
- # - "12" for "Pacific/Auckland"
- # - "13" for "America/Sao_Paulo"
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- },
- "active": True or False, # Whether this account is active.
- "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
- "id": "A String", # ID of this account. This is a read-only, auto-generated field.
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing account.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a DCM account.
- "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
- "countryId": "A String", # ID of the country associated with this account.
- "availablePermissionIds": [ # User role permissions available to the user roles of this account.
- "A String",
- ],
- "description": "A String", # Description of this account.
- "maximumImageSize": "A String", # Maximum image size allowed for this account.
- "currencyId": "A String", # ID of currency associated with this account. This is a required field.
- # Acceptable values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
- "accountPermissionIds": [ # Account permissions assigned to this account.
- "A String",
- ],
- "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
- "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
- "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
- "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
- "locale": "A String", # Locale of this account.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
- "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
- "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
- # Acceptable values are:
- #
- # - "1" for "America/New_York"
- # - "2" for "Europe/London"
- # - "3" for "Europe/Paris"
- # - "4" for "Africa/Johannesburg"
- # - "5" for "Asia/Jerusalem"
- # - "6" for "Asia/Shanghai"
- # - "7" for "Asia/Hong_Kong"
- # - "8" for "Asia/Tokyo"
- # - "9" for "Australia/Sydney"
- # - "10" for "Asia/Dubai"
- # - "11" for "America/Los_Angeles"
- # - "12" for "Pacific/Auckland"
- # - "13" for "America/Sao_Paulo"
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- },
- "active": True or False, # Whether this account is active.
- "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
- "id": "A String", # ID of this account. This is a read-only, auto-generated field.
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DCM account.
- "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
- "countryId": "A String", # ID of the country associated with this account.
- "availablePermissionIds": [ # User role permissions available to the user roles of this account.
- "A String",
- ],
- "description": "A String", # Description of this account.
- "maximumImageSize": "A String", # Maximum image size allowed for this account.
- "currencyId": "A String", # ID of currency associated with this account. This is a required field.
- # Acceptable values are:
- # - "1" for USD
- # - "2" for GBP
- # - "3" for ESP
- # - "4" for SEK
- # - "5" for CAD
- # - "6" for JPY
- # - "7" for DEM
- # - "8" for AUD
- # - "9" for FRF
- # - "10" for ITL
- # - "11" for DKK
- # - "12" for NOK
- # - "13" for FIM
- # - "14" for ZAR
- # - "15" for IEP
- # - "16" for NLG
- # - "17" for EUR
- # - "18" for KRW
- # - "19" for TWD
- # - "20" for SGD
- # - "21" for CNY
- # - "22" for HKD
- # - "23" for NZD
- # - "24" for MYR
- # - "25" for BRL
- # - "26" for PTE
- # - "27" for MXP
- # - "28" for CLP
- # - "29" for TRY
- # - "30" for ARS
- # - "31" for PEN
- # - "32" for ILS
- # - "33" for CHF
- # - "34" for VEF
- # - "35" for COP
- # - "36" for GTQ
- "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
- "accountPermissionIds": [ # Account permissions assigned to this account.
- "A String",
- ],
- "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
- "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
- "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
- "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
- "locale": "A String", # Locale of this account.
- # Acceptable values are:
- # - "cs" (Czech)
- # - "de" (German)
- # - "en" (English)
- # - "en-GB" (English United Kingdom)
- # - "es" (Spanish)
- # - "fr" (French)
- # - "it" (Italian)
- # - "ja" (Japanese)
- # - "ko" (Korean)
- # - "pl" (Polish)
- # - "pt-BR" (Portuguese Brazil)
- # - "ru" (Russian)
- # - "sv" (Swedish)
- # - "tr" (Turkish)
- # - "zh-CN" (Chinese Simplified)
- # - "zh-TW" (Chinese Traditional)
- "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
- "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
- "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
- # Acceptable values are:
- #
- # - "1" for "America/New_York"
- # - "2" for "Europe/London"
- # - "3" for "Europe/Paris"
- # - "4" for "Africa/Johannesburg"
- # - "5" for "Asia/Jerusalem"
- # - "6" for "Asia/Shanghai"
- # - "7" for "Asia/Hong_Kong"
- # - "8" for "Asia/Tokyo"
- # - "9" for "Australia/Sydney"
- # - "10" for "Asia/Dubai"
- # - "11" for "America/Los_Angeles"
- # - "12" for "Pacific/Auckland"
- # - "13" for "America/Sao_Paulo"
- "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- },
- "active": True or False, # Whether this account is active.
- "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
- "id": "A String", # ID of this account. This is a read-only, auto-generated field.
- "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.advertiserGroups.html b/docs/dyn/dfareporting_v2_2.advertiserGroups.html
deleted file mode 100644
index ee86752..0000000
--- a/docs/dyn/dfareporting_v2_2.advertiserGroups.html
+++ /dev/null
@@ -1,263 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.advertiserGroups.html">advertiserGroups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing advertiser group.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one advertiser group by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new advertiser group.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of advertiser groups, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing advertiser group. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing advertiser group.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing advertiser group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Advertiser group ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one advertiser group by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Advertiser group ID. (required)
-
-Returns:
- An object of the form:
-
- { # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new advertiser group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Retrieves a list of advertiser groups, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only advertiser groups with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Advertiser Group List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#advertiserGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".
- "advertiserGroups": [ # Advertiser group collection.
- { # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing advertiser group. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Advertiser group ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing advertiser group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Groups advertisers together so that reports can be generated for the entire group at once.
- "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
- "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
- "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
- "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.browsers.html b/docs/dyn/dfareporting_v2_2.browsers.html
deleted file mode 100644
index 159b056..0000000
--- a/docs/dyn/dfareporting_v2_2.browsers.html
+++ /dev/null
@@ -1,106 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.browsers.html">browsers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of browsers.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of browsers.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Browser List Response
- "kind": "dfareporting#browsersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse".
- "browsers": [ # Browser collection.
- { # Contains information about a browser that can be targeted by ads.
- "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
- "name": "A String", # Name of this browser.
- "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
- "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
- "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.campaignCreativeAssociations.html b/docs/dyn/dfareporting_v2_2.campaignCreativeAssociations.html
deleted file mode 100644
index 35b2faa..0000000
--- a/docs/dyn/dfareporting_v2_2.campaignCreativeAssociations.html
+++ /dev/null
@@ -1,155 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.campaignCreativeAssociations.html">campaignCreativeAssociations</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, campaignId, body)</a></code></p>
-<p class="firstline">Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves the list of creative IDs associated with the specified campaign.</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="insert">insert(profileId, campaignId, body)</code>
- <pre>Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Campaign ID in this association. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Identifies a creative which has been associated with a given campaign.
- "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
- "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
- }
-
-
-Returns:
- An object of the form:
-
- { # Identifies a creative which has been associated with a given campaign.
- "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
- "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None)</code>
- <pre>Retrieves the list of creative IDs associated with the specified campaign.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Campaign ID in this association. (required)
- maxResults: integer, Maximum number of results to return.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Campaign Creative Association List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "campaignCreativeAssociations": [ # Campaign creative association collection
- { # Identifies a creative which has been associated with a given campaign.
- "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
- "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
- },
- ],
- "kind": "dfareporting#campaignCreativeAssociationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse".
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.cities.html b/docs/dyn/dfareporting_v2_2.cities.html
deleted file mode 100644
index d0b51f9..0000000
--- a/docs/dyn/dfareporting_v2_2.cities.html
+++ /dev/null
@@ -1,113 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.cities.html">cities</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None)</a></code></p>
-<p class="firstline">Retrieves a list of cities, possibly filtered.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None)</code>
- <pre>Retrieves a list of cities, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- dartIds: string, Select only cities with these DART IDs. (repeated)
- namePrefix: string, Select only cities with names starting with this prefix.
- regionDartIds: string, Select only cities from these regions. (repeated)
- countryDartIds: string, Select only cities from these countries. (repeated)
-
-Returns:
- An object of the form:
-
- { # City List Response
- "kind": "dfareporting#citiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".
- "cities": [ # City collection.
- { # Contains information about a city that can be targeted by ads.
- "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
- "countryDartId": "A String", # DART ID of the country to which this city belongs.
- "name": "A String", # Name of this city.
- "countryCode": "A String", # Country code of the country to which this city belongs.
- "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
- "regionCode": "A String", # Region code of the region to which this city belongs.
- "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
- "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
- "regionDartId": "A String", # DART ID of the region to which this city belongs.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.contentCategories.html b/docs/dyn/dfareporting_v2_2.contentCategories.html
deleted file mode 100644
index 0af3e92..0000000
--- a/docs/dyn/dfareporting_v2_2.contentCategories.html
+++ /dev/null
@@ -1,263 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.contentCategories.html">contentCategories</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing content category.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one content category by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new content category.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of content categories, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing content category. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing content category.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing content category.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Content category ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one content category by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Content category ID. (required)
-
-Returns:
- An object of the form:
-
- { # Organizes placements according to the contents of their associated webpages.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new content category.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Organizes placements according to the contents of their associated webpages.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Organizes placements according to the contents of their associated webpages.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Retrieves a list of content categories, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only content categories with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Content Category List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#contentCategoriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse".
- "contentCategories": [ # Content category collection.
- { # Organizes placements according to the contents of their associated webpages.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing content category. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Content category ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Organizes placements according to the contents of their associated webpages.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Organizes placements according to the contents of their associated webpages.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing content category.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Organizes placements according to the contents of their associated webpages.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Organizes placements according to the contents of their associated webpages.
- "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
- "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
- "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
- "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.countries.html b/docs/dyn/dfareporting_v2_2.countries.html
deleted file mode 100644
index e14c18a..0000000
--- a/docs/dyn/dfareporting_v2_2.countries.html
+++ /dev/null
@@ -1,128 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.countries.html">countries</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, dartId)</a></code></p>
-<p class="firstline">Gets one country by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of countries.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, dartId)</code>
- <pre>Gets one country by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- dartId: string, Country DART ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of countries.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Country List Response
- "kind": "dfareporting#countriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse".
- "countries": [ # Country collection.
- { # Contains information about a country that can be targeted by ads.
- "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
- "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
- "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
- "countryCode": "A String", # Country code.
- "name": "A String", # Name of this country.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.creativeAssets.html b/docs/dyn/dfareporting_v2_2.creativeAssets.html
deleted file mode 100644
index 1b37ef8..0000000
--- a/docs/dyn/dfareporting_v2_2.creativeAssets.html
+++ /dev/null
@@ -1,185 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.creativeAssets.html">creativeAssets</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, advertiserId, body=None, media_body=None)</a></code></p>
-<p class="firstline">Inserts a new creative asset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="insert">insert(profileId, advertiserId, body=None, media_body=None)</code>
- <pre>Inserts a new creative asset.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- advertiserId: string, Advertiser ID of this creative. This is a required field. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
- "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
- #
- # Possible values are:
- # - "CLICK_TAG_NON_TOP_LEVEL"
- # - "CLICK_TAG_MISSING"
- # - "CLICK_TAG_MORE_THAN_ONE"
- # - "CLICK_TAG_INVALID"
- # - "ORPHANED_ASSET"
- # - "PRIMARY_HTML_MISSING"
- # - "EXTERNAL_FILE_REFERENCED"
- # - "MRAID_REFERENCED"
- # - "ADMOB_REFERENCED"
- # - "FILE_TYPE_INVALID"
- # - "ZIP_INVALID"
- # - "LINKED_FILE_NOT_FOUND"
- # - "MAX_FLASH_VERSION_11"
- # - "NOT_SSL_COMPLIANT"
- # - "FILE_DETAIL_EMPTY"
- # - "ASSET_INVALID"
- # - "GWD_PROPERTIES_INVALID"
- # - "ENABLER_UNSUPPORTED_METHOD_DCM"
- # - "ASSET_FORMAT_UNSUPPORTED_DCM"
- # - "COMPONENT_UNSUPPORTED_DCM"
- # - "HTML5_FEATURE_UNSUPPORTED' "
- "A String",
- ],
- "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
- "A String",
- ],
- "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
- "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- }
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
-
-Returns:
- An object of the form:
-
- { # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
- "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
- #
- # Possible values are:
- # - "CLICK_TAG_NON_TOP_LEVEL"
- # - "CLICK_TAG_MISSING"
- # - "CLICK_TAG_MORE_THAN_ONE"
- # - "CLICK_TAG_INVALID"
- # - "ORPHANED_ASSET"
- # - "PRIMARY_HTML_MISSING"
- # - "EXTERNAL_FILE_REFERENCED"
- # - "MRAID_REFERENCED"
- # - "ADMOB_REFERENCED"
- # - "FILE_TYPE_INVALID"
- # - "ZIP_INVALID"
- # - "LINKED_FILE_NOT_FOUND"
- # - "MAX_FLASH_VERSION_11"
- # - "NOT_SSL_COMPLIANT"
- # - "FILE_DETAIL_EMPTY"
- # - "ASSET_INVALID"
- # - "GWD_PROPERTIES_INVALID"
- # - "ENABLER_UNSUPPORTED_METHOD_DCM"
- # - "ASSET_FORMAT_UNSUPPORTED_DCM"
- # - "COMPONENT_UNSUPPORTED_DCM"
- # - "HTML5_FEATURE_UNSUPPORTED' "
- "A String",
- ],
- "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
- { # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
- "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
- },
- ],
- "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
- "A String",
- ],
- "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
- "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
- "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
- "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
- },
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.creativeFieldValues.html b/docs/dyn/dfareporting_v2_2.creativeFieldValues.html
deleted file mode 100644
index bcc4465..0000000
--- a/docs/dyn/dfareporting_v2_2.creativeFieldValues.html
+++ /dev/null
@@ -1,261 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.creativeFieldValues.html">creativeFieldValues</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, creativeFieldId, id)</a></code></p>
-<p class="firstline">Deletes an existing creative field value.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, creativeFieldId, id)</a></code></p>
-<p class="firstline">Gets one creative field value by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, creativeFieldId, body)</a></code></p>
-<p class="firstline">Inserts a new creative field value.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of creative field values, possibly filtered.</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(profileId, creativeFieldId, id, body)</a></code></p>
-<p class="firstline">Updates an existing creative field value. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, creativeFieldId, body)</a></code></p>
-<p class="firstline">Updates an existing creative field value.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, creativeFieldId, id)</code>
- <pre>Deletes an existing creative field value.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- creativeFieldId: string, Creative field ID for this creative field value. (required)
- id: string, Creative Field Value ID (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, creativeFieldId, id)</code>
- <pre>Gets one creative field value by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- creativeFieldId: string, Creative field ID for this creative field value. (required)
- id: string, Creative Field Value ID (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, creativeFieldId, body)</code>
- <pre>Inserts a new creative field value.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- creativeFieldId: string, Creative field ID for this creative field value. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None)</code>
- <pre>Retrieves a list of creative field values, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- creativeFieldId: string, Creative field ID for this creative field value. (required)
- searchString: string, Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- VALUE -
- ids: string, Select only creative field values with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Creative Field Value List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#creativeFieldValuesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse".
- "creativeFieldValues": [ # Creative field value collection.
- { # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- },
- ],
- }</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(profileId, creativeFieldId, id, body)</code>
- <pre>Updates an existing creative field value. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- creativeFieldId: string, Creative field ID for this creative field value. (required)
- id: string, Creative Field Value ID (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, creativeFieldId, body)</code>
- <pre>Updates an existing creative field value.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- creativeFieldId: string, Creative field ID for this creative field value. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field value.
- "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
- "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
- "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.creativeFields.html b/docs/dyn/dfareporting_v2_2.creativeFields.html
deleted file mode 100644
index b2ffd72..0000000
--- a/docs/dyn/dfareporting_v2_2.creativeFields.html
+++ /dev/null
@@ -1,344 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.creativeFields.html">creativeFields</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing creative field.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one creative field by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new creative field.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of creative fields, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing creative field. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing creative field.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing creative field.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative Field ID (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one creative field by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative Field ID (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new creative field.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Retrieves a list of creative fields, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- advertiserIds: string, Select only creative fields that belong to these advertisers. (repeated)
- ids: string, Select only creative fields with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Creative Field List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "creativeFields": [ # Creative field collection.
- { # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- },
- ],
- "kind": "dfareporting#creativeFieldsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse".
- }</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(profileId, id, body)</code>
- <pre>Updates an existing creative field. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative Field ID (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing creative field.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative field.
- "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
- "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
- "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative field. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.creativeGroups.html b/docs/dyn/dfareporting_v2_2.creativeGroups.html
deleted file mode 100644
index 13760b8..0000000
--- a/docs/dyn/dfareporting_v2_2.creativeGroups.html
+++ /dev/null
@@ -1,364 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.creativeGroups.html">creativeGroups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one creative group by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new creative group.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of creative groups, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing creative group. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing creative group.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one creative group by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative group ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new creative group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None)</code>
- <pre>Retrieves a list of creative groups, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- advertiserIds: string, Select only creative groups that belong to these advertisers. (repeated)
- groupNumber: integer, Select only creative groups that belong to this subgroup.
- maxResults: integer, Maximum number of results to return.
- ids: string, Select only creative groups with these IDs. (repeated)
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Creative Group List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "creativeGroups": [ # Creative group collection.
- { # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- },
- ],
- "kind": "dfareporting#creativeGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse".
- }</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(profileId, id, body)</code>
- <pre>Updates an existing creative group. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Creative group ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing creative group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a creative group.
- "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
- "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
- "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
- "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion.
- # Acceptable values are:
- # - 1
- # - 2
- "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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", # ID of this creative group. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.files.html b/docs/dyn/dfareporting_v2_2.files.html
deleted file mode 100644
index cc2b9d4..0000000
--- a/docs/dyn/dfareporting_v2_2.files.html
+++ /dev/null
@@ -1,205 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.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 metadata 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.
- "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.
- },
- "fileName": "A String", # The filename 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 metadata 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.
- "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.
- },
- "fileName": "A String", # The filename 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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.floodlightActivities.html b/docs/dyn/dfareporting_v2_2.floodlightActivities.html
deleted file mode 100644
index 4d4d289..0000000
--- a/docs/dyn/dfareporting_v2_2.floodlightActivities.html
+++ /dev/null
@@ -1,1045 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.floodlightActivities.html">floodlightActivities</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing floodlight activity.</p>
-<p class="toc_element">
- <code><a href="#generatetag">generatetag(profileId, floodlightActivityId=None)</a></code></p>
-<p class="firstline">Generates a tag for a floodlight activity.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one floodlight activity by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new floodlight activity.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)</a></code></p>
-<p class="firstline">Retrieves a list of floodlight activities, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing floodlight activity. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing floodlight activity.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing floodlight activity.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="generatetag">generatetag(profileId, floodlightActivityId=None)</code>
- <pre>Generates a tag for a floodlight activity.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- floodlightActivityId: string, Floodlight activity ID for which we want to generate a tag.
-
-Returns:
- An object of the form:
-
- { # Floodlight Activity GenerateTag Response
- "kind": "dfareporting#floodlightActivitiesGenerateTagResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse".
- "floodlightActivityTag": "A String", # Generated tag for this floodlight activity.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one floodlight activity by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new floodlight activity.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)</code>
- <pre>Retrieves a list of floodlight activities, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name.
- advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
- tagString: string, Select only floodlight activities with the specified tag string.
- floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string.
- floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated)
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- maxResults: integer, Maximum number of results to return.
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
- ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated)
- floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type.
- Allowed values
- COUNTER -
- SALE -
-
-Returns:
- An object of the form:
-
- { # Floodlight Activity List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#floodlightActivitiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".
- "floodlightActivities": [ # Floodlight activity collection.
- { # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing floodlight activity. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing floodlight activity.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a Floodlight activity.
- "tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
- "secure": True or False, # Whether this tag should use SSL.
- "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
- "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
- "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
- "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
- "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
- "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
- "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
- "publisherTags": [ # Publisher dynamic floodlight tags.
- { # Publisher Dynamic Tag
- "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
- "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
- "siteId": "A String", # Site ID of this dynamic tag.
- "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
- "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- ],
- "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
- "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "hidden": True or False, # Whether this activity is archived.
- "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
- "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
- "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
- "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
- "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
- "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
- "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
- "notes": "A String", # General notes or implementation instructions for the tag.
- "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
- "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type.
- # Acceptable values are:
- # - "U1"
- # - "U2"
- # - "U3"
- # - "U4"
- # - "U5"
- # - "U6"
- # - "U7"
- # - "U8"
- # - "U9"
- # - "U10"
- # - "U11"
- # - "U12"
- # - "U13"
- # - "U14"
- # - "U15"
- # - "U16"
- # - "U17"
- # - "U18"
- # - "U19"
- # - "U20"
- "A String",
- ],
- "defaultTags": [ # Dynamic floodlight tags.
- { # Dynamic Tag
- "tag": "A String", # Tag code.
- "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
- "name": "A String", # Name of this tag.
- },
- ],
- "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
- "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.html b/docs/dyn/dfareporting_v2_2.html
deleted file mode 100644
index 6c004de..0000000
--- a/docs/dyn/dfareporting_v2_2.html
+++ /dev/null
@@ -1,373 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.accountActiveAdSummaries.html">accountActiveAdSummaries()</a></code>
-</p>
-<p class="firstline">Returns the accountActiveAdSummaries Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.accountPermissionGroups.html">accountPermissionGroups()</a></code>
-</p>
-<p class="firstline">Returns the accountPermissionGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.accountPermissions.html">accountPermissions()</a></code>
-</p>
-<p class="firstline">Returns the accountPermissions Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.accountUserProfiles.html">accountUserProfiles()</a></code>
-</p>
-<p class="firstline">Returns the accountUserProfiles Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.accounts.html">accounts()</a></code>
-</p>
-<p class="firstline">Returns the accounts Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.ads.html">ads()</a></code>
-</p>
-<p class="firstline">Returns the ads Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.advertiserGroups.html">advertiserGroups()</a></code>
-</p>
-<p class="firstline">Returns the advertiserGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.advertisers.html">advertisers()</a></code>
-</p>
-<p class="firstline">Returns the advertisers Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.browsers.html">browsers()</a></code>
-</p>
-<p class="firstline">Returns the browsers Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.campaignCreativeAssociations.html">campaignCreativeAssociations()</a></code>
-</p>
-<p class="firstline">Returns the campaignCreativeAssociations Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.campaigns.html">campaigns()</a></code>
-</p>
-<p class="firstline">Returns the campaigns Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.changeLogs.html">changeLogs()</a></code>
-</p>
-<p class="firstline">Returns the changeLogs Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.cities.html">cities()</a></code>
-</p>
-<p class="firstline">Returns the cities Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.connectionTypes.html">connectionTypes()</a></code>
-</p>
-<p class="firstline">Returns the connectionTypes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.contentCategories.html">contentCategories()</a></code>
-</p>
-<p class="firstline">Returns the contentCategories Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.countries.html">countries()</a></code>
-</p>
-<p class="firstline">Returns the countries Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.creativeAssets.html">creativeAssets()</a></code>
-</p>
-<p class="firstline">Returns the creativeAssets Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.creativeFieldValues.html">creativeFieldValues()</a></code>
-</p>
-<p class="firstline">Returns the creativeFieldValues Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.creativeFields.html">creativeFields()</a></code>
-</p>
-<p class="firstline">Returns the creativeFields Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.creativeGroups.html">creativeGroups()</a></code>
-</p>
-<p class="firstline">Returns the creativeGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.creatives.html">creatives()</a></code>
-</p>
-<p class="firstline">Returns the creatives Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.dimensionValues.html">dimensionValues()</a></code>
-</p>
-<p class="firstline">Returns the dimensionValues Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.directorySiteContacts.html">directorySiteContacts()</a></code>
-</p>
-<p class="firstline">Returns the directorySiteContacts Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.directorySites.html">directorySites()</a></code>
-</p>
-<p class="firstline">Returns the directorySites Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.eventTags.html">eventTags()</a></code>
-</p>
-<p class="firstline">Returns the eventTags Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.files.html">files()</a></code>
-</p>
-<p class="firstline">Returns the files Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.floodlightActivities.html">floodlightActivities()</a></code>
-</p>
-<p class="firstline">Returns the floodlightActivities Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.floodlightActivityGroups.html">floodlightActivityGroups()</a></code>
-</p>
-<p class="firstline">Returns the floodlightActivityGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.floodlightConfigurations.html">floodlightConfigurations()</a></code>
-</p>
-<p class="firstline">Returns the floodlightConfigurations Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.inventoryItems.html">inventoryItems()</a></code>
-</p>
-<p class="firstline">Returns the inventoryItems Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.landingPages.html">landingPages()</a></code>
-</p>
-<p class="firstline">Returns the landingPages Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.metros.html">metros()</a></code>
-</p>
-<p class="firstline">Returns the metros Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.mobileCarriers.html">mobileCarriers()</a></code>
-</p>
-<p class="firstline">Returns the mobileCarriers Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.operatingSystemVersions.html">operatingSystemVersions()</a></code>
-</p>
-<p class="firstline">Returns the operatingSystemVersions Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.operatingSystems.html">operatingSystems()</a></code>
-</p>
-<p class="firstline">Returns the operatingSystems Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.orderDocuments.html">orderDocuments()</a></code>
-</p>
-<p class="firstline">Returns the orderDocuments Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.orders.html">orders()</a></code>
-</p>
-<p class="firstline">Returns the orders Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.placementGroups.html">placementGroups()</a></code>
-</p>
-<p class="firstline">Returns the placementGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.placementStrategies.html">placementStrategies()</a></code>
-</p>
-<p class="firstline">Returns the placementStrategies Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.placements.html">placements()</a></code>
-</p>
-<p class="firstline">Returns the placements Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.platformTypes.html">platformTypes()</a></code>
-</p>
-<p class="firstline">Returns the platformTypes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.postalCodes.html">postalCodes()</a></code>
-</p>
-<p class="firstline">Returns the postalCodes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.projects.html">projects()</a></code>
-</p>
-<p class="firstline">Returns the projects Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.regions.html">regions()</a></code>
-</p>
-<p class="firstline">Returns the regions Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.remarketingListShares.html">remarketingListShares()</a></code>
-</p>
-<p class="firstline">Returns the remarketingListShares Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.remarketingLists.html">remarketingLists()</a></code>
-</p>
-<p class="firstline">Returns the remarketingLists Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.reports.html">reports()</a></code>
-</p>
-<p class="firstline">Returns the reports Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.sites.html">sites()</a></code>
-</p>
-<p class="firstline">Returns the sites Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.sizes.html">sizes()</a></code>
-</p>
-<p class="firstline">Returns the sizes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.subaccounts.html">subaccounts()</a></code>
-</p>
-<p class="firstline">Returns the subaccounts Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.targetableRemarketingLists.html">targetableRemarketingLists()</a></code>
-</p>
-<p class="firstline">Returns the targetableRemarketingLists Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.userProfiles.html">userProfiles()</a></code>
-</p>
-<p class="firstline">Returns the userProfiles Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.userRolePermissionGroups.html">userRolePermissionGroups()</a></code>
-</p>
-<p class="firstline">Returns the userRolePermissionGroups Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.userRolePermissions.html">userRolePermissions()</a></code>
-</p>
-<p class="firstline">Returns the userRolePermissions Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.userRoles.html">userRoles()</a></code>
-</p>
-<p class="firstline">Returns the userRoles Resource.</p>
-
-<p class="toc_element">
- <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
-<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
- <pre>Create a BatchHttpRequest object based on the discovery document.
-
- Args:
- callback: callable, A callback to be called for each response, of the
- form callback(id, response, exception). The first parameter is the
- request id, and the second is the deserialized response object. The
- third is an apiclient.errors.HttpError exception object if an HTTP
- error occurred while processing the request, or None if no error
- occurred.
-
- Returns:
- A BatchHttpRequest object based on the discovery document.
- </pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.inventoryItems.html b/docs/dyn/dfareporting_v2_2.inventoryItems.html
deleted file mode 100644
index bf22ec4..0000000
--- a/docs/dyn/dfareporting_v2_2.inventoryItems.html
+++ /dev/null
@@ -1,244 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.inventoryItems.html">inventoryItems</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, projectId, id)</a></code></p>
-<p class="firstline">Gets one inventory item by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, projectId, orderId=None, pageToken=None, sortField=None, ids=None, maxResults=None, inPlan=None, siteId=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of inventory items, possibly filtered.</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(profileId, projectId, id)</code>
- <pre>Gets one inventory item by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- projectId: string, Project ID for order documents. (required)
- id: string, Inventory item ID. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a buy from the DoubleClick Planning inventory store.
- "orderId": "A String", # Order ID of this inventory item.
- "pricing": { # Pricing Information # Pricing of this inventory item.
- "groupType": "A String", # Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
- "startDate": "A String", # Start date of this inventory item.
- "endDate": "A String", # End date of this inventory item.
- "pricingType": "A String", # Pricing type of this inventory item.
- "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
- { # Flight
- "rateOrCost": "A String", # Rate or cost of this flight.
- "startDate": "A String", # Inventory item flight start date.
- "units": "A String", # Units of this flight.
- "endDate": "A String", # Inventory item flight end date.
- },
- ],
- "capCostType": "A String", # Cap cost type of this inventory item.
- },
- "kind": "dfareporting#inventoryItem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
- "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
- "subaccountId": "A String", # Subaccount ID of this inventory item.
- "name": "A String", # Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
- "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
- "inPlan": True or False, # Whether this inventory item is in plan.
- "id": "A String", # ID of this inventory item.
- "advertiserId": "A String", # Advertiser ID of this inventory item.
- "siteId": "A String", # ID of the site this inventory item is associated with.
- "adSlots": [ # Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
- { # Ad Slot
- "comment": "A String", # Comment for this ad slot.
- "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
- "name": "A String", # Name of this ad slot.
- "primary": True or False, # Primary ad slot of a roadblock inventory item.
- "height": "A String", # Height of this ad slot.
- "width": "A String", # Width of this ad slot.
- "paymentSourceType": "A String", # Payment source type of this ad slot.
- "compatibility": "A String", # Ad slot compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
- },
- ],
- "projectId": "A String", # Project ID of this inventory item.
- "rfpId": "A String", # RFP ID of this inventory item.
- "contentCategoryId": "A String", # Content category ID of this inventory item.
- "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
- "accountId": "A String", # Account ID of this inventory item.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, projectId, orderId=None, pageToken=None, sortField=None, ids=None, maxResults=None, inPlan=None, siteId=None, sortOrder=None)</code>
- <pre>Retrieves a list of inventory items, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- projectId: string, Project ID for order documents. (required)
- orderId: string, Select only inventory items that belong to specified orders. (repeated)
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only inventory items with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- inPlan: boolean, Select only inventory items that are in plan.
- siteId: string, Select only inventory items that are associated with these sites. (repeated)
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Inventory item List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#inventoryItemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse".
- "inventoryItems": [ # Inventory item collection
- { # Represents a buy from the DoubleClick Planning inventory store.
- "orderId": "A String", # Order ID of this inventory item.
- "pricing": { # Pricing Information # Pricing of this inventory item.
- "groupType": "A String", # Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
- "startDate": "A String", # Start date of this inventory item.
- "endDate": "A String", # End date of this inventory item.
- "pricingType": "A String", # Pricing type of this inventory item.
- "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
- { # Flight
- "rateOrCost": "A String", # Rate or cost of this flight.
- "startDate": "A String", # Inventory item flight start date.
- "units": "A String", # Units of this flight.
- "endDate": "A String", # Inventory item flight end date.
- },
- ],
- "capCostType": "A String", # Cap cost type of this inventory item.
- },
- "kind": "dfareporting#inventoryItem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
- "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
- "subaccountId": "A String", # Subaccount ID of this inventory item.
- "name": "A String", # Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
- "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
- "inPlan": True or False, # Whether this inventory item is in plan.
- "id": "A String", # ID of this inventory item.
- "advertiserId": "A String", # Advertiser ID of this inventory item.
- "siteId": "A String", # ID of the site this inventory item is associated with.
- "adSlots": [ # Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
- { # Ad Slot
- "comment": "A String", # Comment for this ad slot.
- "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
- "name": "A String", # Name of this ad slot.
- "primary": True or False, # Primary ad slot of a roadblock inventory item.
- "height": "A String", # Height of this ad slot.
- "width": "A String", # Width of this ad slot.
- "paymentSourceType": "A String", # Payment source type of this ad slot.
- "compatibility": "A String", # Ad slot compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
- },
- ],
- "projectId": "A String", # Project ID of this inventory item.
- "rfpId": "A String", # RFP ID of this inventory item.
- "contentCategoryId": "A String", # Content category ID of this inventory item.
- "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
- "accountId": "A String", # Account ID of this inventory item.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.landingPages.html b/docs/dyn/dfareporting_v2_2.landingPages.html
deleted file mode 100644
index 3604e75..0000000
--- a/docs/dyn/dfareporting_v2_2.landingPages.html
+++ /dev/null
@@ -1,247 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.landingPages.html">landingPages</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, campaignId, id)</a></code></p>
-<p class="firstline">Deletes an existing campaign landing page.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, campaignId, id)</a></code></p>
-<p class="firstline">Gets one campaign landing page by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, campaignId, body)</a></code></p>
-<p class="firstline">Inserts a new landing page for the specified campaign.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, campaignId)</a></code></p>
-<p class="firstline">Retrieves the list of landing pages for the specified campaign.</p>
-<p class="toc_element">
- <code><a href="#patch">patch(profileId, campaignId, id, body)</a></code></p>
-<p class="firstline">Updates an existing campaign landing page. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, campaignId, body)</a></code></p>
-<p class="firstline">Updates an existing campaign landing page.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, campaignId, id)</code>
- <pre>Deletes an existing campaign landing page.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Landing page campaign ID. (required)
- id: string, Landing page ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, campaignId, id)</code>
- <pre>Gets one campaign landing page by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Landing page campaign ID. (required)
- id: string, Landing page ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, campaignId, body)</code>
- <pre>Inserts a new landing page for the specified campaign.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Landing page campaign ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, campaignId)</code>
- <pre>Retrieves the list of landing pages for the specified campaign.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Landing page campaign ID. (required)
-
-Returns:
- An object of the form:
-
- { # Landing Page List Response
- "kind": "dfareporting#landingPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPagesListResponse".
- "landingPages": [ # Landing page collection
- { # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(profileId, campaignId, id, body)</code>
- <pre>Updates an existing campaign landing page. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Landing page campaign ID. (required)
- id: string, Landing page ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, campaignId, body)</code>
- <pre>Updates an existing campaign landing page.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- campaignId: string, Landing page campaign ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains information about where a user's browser is taken after the user clicks an ad.
- "default": True or False, # Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.
- "url": "A String", # URL of this landing page. This is a required field.
- "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
- "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
- "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.metros.html b/docs/dyn/dfareporting_v2_2.metros.html
deleted file mode 100644
index b28cfc4..0000000
--- a/docs/dyn/dfareporting_v2_2.metros.html
+++ /dev/null
@@ -1,107 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.metros.html">metros</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of metros.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of metros.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Metro List Response
- "kind": "dfareporting#metrosListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse".
- "metros": [ # Metro collection.
- { # Contains information about a metro region that can be targeted by ads.
- "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
- "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
- "name": "A String", # Name of this metro region.
- "countryCode": "A String", # Country code of the country to which this metro region belongs.
- "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
- "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
- "dartId": "A String", # DART ID of this metro region.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.mobileCarriers.html b/docs/dyn/dfareporting_v2_2.mobileCarriers.html
deleted file mode 100644
index 6f2c5a5..0000000
--- a/docs/dyn/dfareporting_v2_2.mobileCarriers.html
+++ /dev/null
@@ -1,128 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.mobileCarriers.html">mobileCarriers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one mobile carrier by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of mobile carriers.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one mobile carrier by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Mobile carrier ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of mobile carriers.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Mobile Carrier List Response
- "kind": "dfareporting#mobileCarriersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse".
- "mobileCarriers": [ # Mobile carrier collection.
- { # Contains information about a mobile carrier that can be targeted by ads.
- "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
- "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
- "id": "A String", # ID of this mobile carrier.
- "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
- "name": "A String", # Name of this mobile carrier.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.operatingSystems.html b/docs/dyn/dfareporting_v2_2.operatingSystems.html
deleted file mode 100644
index 67ad450..0000000
--- a/docs/dyn/dfareporting_v2_2.operatingSystems.html
+++ /dev/null
@@ -1,128 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.operatingSystems.html">operatingSystems</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, dartId)</a></code></p>
-<p class="firstline">Gets one operating system by DART ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of operating systems.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, dartId)</code>
- <pre>Gets one operating system by DART ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- dartId: string, Operating system DART ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of operating systems.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Operating System List Response
- "kind": "dfareporting#operatingSystemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse".
- "operatingSystems": [ # Operating system collection.
- { # Contains information about an operating system that can be targeted by ads.
- "mobile": True or False, # Whether this operating system is for mobile.
- "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
- "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
- "name": "A String", # Name of this operating system.
- "desktop": True or False, # Whether this operating system is for desktop.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.placementStrategies.html b/docs/dyn/dfareporting_v2_2.placementStrategies.html
deleted file mode 100644
index 38f4713..0000000
--- a/docs/dyn/dfareporting_v2_2.placementStrategies.html
+++ /dev/null
@@ -1,263 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.placementStrategies.html">placementStrategies</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing placement strategy.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one placement strategy by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new placement strategy.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of placement strategies, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing placement strategy. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing placement strategy.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing placement strategy.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement strategy ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one placement strategy by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement strategy ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new placement strategy.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Retrieves a list of placement strategies, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only placement strategies with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Placement Strategy List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#placementStrategiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse".
- "placementStrategies": [ # Placement strategy collection.
- { # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing placement strategy. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Placement strategy ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing placement strategy.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a placement strategy.
- "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
- "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
- "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
- "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.platformTypes.html b/docs/dyn/dfareporting_v2_2.platformTypes.html
deleted file mode 100644
index d33cb4d..0000000
--- a/docs/dyn/dfareporting_v2_2.platformTypes.html
+++ /dev/null
@@ -1,124 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.platformTypes.html">platformTypes</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one platform type by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Retrieves a list of platform types.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one platform type by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Platform type ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Retrieves a list of platform types.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # Platform Type List Response
- "kind": "dfareporting#platformTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse".
- "platformTypes": [ # Platform type collection.
- { # Contains information about a platform type that can be targeted by ads.
- "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
- "id": "A String", # ID of this platform type.
- "name": "A String", # Name of this platform type.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.projects.html b/docs/dyn/dfareporting_v2_2.projects.html
deleted file mode 100644
index fd07201..0000000
--- a/docs/dyn/dfareporting_v2_2.projects.html
+++ /dev/null
@@ -1,195 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.projects.html">projects</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one project by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Retrieves a list of projects, possibly filtered.</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(profileId, id)</code>
- <pre>Gets one project by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Project ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a DoubleClick Planning project.
- "startDate": "A String", # Start date of the project.
- "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
- "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
- "endDate": "A String", # End date of the project.
- "name": "A String", # Name of this project.
- "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
- "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
- "clientBillingCode": "A String", # Client billing code of this project.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
- "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
- "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
- "advertiserId": "A String", # Advertiser ID of this project.
- "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
- "overview": "A String", # Overview of this project.
- "audienceAgeGroup": "A String", # Audience age group of this project.
- "subaccountId": "A String", # Subaccount ID of this project.
- "audienceGender": "A String", # Audience gender of this project.
- "id": "A String", # ID of this project. This is a read-only, auto-generated field.
- "clientName": "A String", # Name of the project client.
- "accountId": "A String", # Account ID of this project.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)</code>
- <pre>Retrieves a list of projects, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project".
- pageToken: string, Value of the nextPageToken from the previous result page.
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- advertiserIds: string, Select only projects with these advertiser IDs. (repeated)
- ids: string, Select only projects with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
-
-Returns:
- An object of the form:
-
- { # Project List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#projectsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".
- "projects": [ # Project collection.
- { # Contains properties of a DoubleClick Planning project.
- "startDate": "A String", # Start date of the project.
- "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
- "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
- "endDate": "A String", # End date of the project.
- "name": "A String", # Name of this project.
- "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
- "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
- "clientBillingCode": "A String", # Client billing code of this project.
- "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
- "time": "A String", # Timestamp of the last change in milliseconds since epoch.
- },
- "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
- "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
- "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
- "advertiserId": "A String", # Advertiser ID of this project.
- "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
- "overview": "A String", # Overview of this project.
- "audienceAgeGroup": "A String", # Audience age group of this project.
- "subaccountId": "A String", # Subaccount ID of this project.
- "audienceGender": "A String", # Audience gender of this project.
- "id": "A String", # ID of this project. This is a read-only, auto-generated field.
- "clientName": "A String", # Name of the project client.
- "accountId": "A String", # Account ID of this project.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.remarketingListShares.html b/docs/dyn/dfareporting_v2_2.remarketingListShares.html
deleted file mode 100644
index e21123b..0000000
--- a/docs/dyn/dfareporting_v2_2.remarketingListShares.html
+++ /dev/null
@@ -1,183 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.remarketingListShares.html">remarketingListShares</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, remarketingListId)</a></code></p>
-<p class="firstline">Gets one remarketing list share by remarketing list ID.</p>
-<p class="toc_element">
- <code><a href="#patch">patch(profileId, remarketingListId, body)</a></code></p>
-<p class="firstline">Updates an existing remarketing list share. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing remarketing list share.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, remarketingListId)</code>
- <pre>Gets one remarketing list share by remarketing list ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- remarketingListId: string, Remarketing list ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
- "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
- "A String",
- ],
- "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
- "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
- "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
- "A String",
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(profileId, remarketingListId, body)</code>
- <pre>Updates an existing remarketing list share. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- remarketingListId: string, Remarketing list ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
- "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
- "A String",
- ],
- "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
- "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
- "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
- "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
- "A String",
- ],
- "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
- "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
- "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
- "A String",
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing remarketing list share.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
- "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
- "A String",
- ],
- "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
- "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
- "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
- "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
- "A String",
- ],
- "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
- "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
- "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
- "A String",
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.reports.files.html b/docs/dyn/dfareporting_v2_2.reports.files.html
deleted file mode 100644
index 7516a68..0000000
--- a/docs/dyn/dfareporting_v2_2.reports.files.html
+++ /dev/null
@@ -1,203 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.reports.html">reports</a> . <a href="dfareporting_v2_2.reports.files.html">files</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, reportId, fileId)</a></code></p>
-<p class="firstline">Retrieves a report file.</p>
-<p class="toc_element">
- <code><a href="#get_media">get_media(profileId, reportId, fileId)</a></code></p>
-<p class="firstline">Retrieves a report file.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)</a></code></p>
-<p class="firstline">Lists files for a report.</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(profileId, reportId, fileId)</code>
- <pre>Retrieves a report file.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- 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 metadata 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.
- "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.
- },
- "fileName": "A String", # The filename 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(profileId, reportId, fileId)</code>
- <pre>Retrieves a report file.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- 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, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)</code>
- <pre>Lists files for a report.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the parent report. (required)
- pageToken: string, The value of the nextToken from the previous result page.
- sortField: string, The field by which to sort the list.
- Allowed values
- ID - Sort by file ID.
- LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
- 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.
-
-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 metadata 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.
- "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.
- },
- "fileName": "A String", # The filename 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>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.reports.html b/docs/dyn/dfareporting_v2_2.reports.html
deleted file mode 100644
index 2ffba95..0000000
--- a/docs/dyn/dfareporting_v2_2.reports.html
+++ /dev/null
@@ -1,2795 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.reports.html">reports</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.reports.compatibleFields.html">compatibleFields()</a></code>
-</p>
-<p class="firstline">Returns the compatibleFields Resource.</p>
-
-<p class="toc_element">
- <code><a href="dfareporting_v2_2.reports.files.html">files()</a></code>
-</p>
-<p class="firstline">Returns the files Resource.</p>
-
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, reportId)</a></code></p>
-<p class="firstline">Deletes a report by its ID.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, reportId)</a></code></p>
-<p class="firstline">Retrieves a report by its ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Creates a report.</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">Retrieves list of reports.</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(profileId, reportId, body)</a></code></p>
-<p class="firstline">Updates a report. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#run">run(profileId, reportId, synchronous=None)</a></code></p>
-<p class="firstline">Runs a report.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, reportId, body)</a></code></p>
-<p class="firstline">Updates a report.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, reportId)</code>
- <pre>Deletes a report by its ID.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, reportId)</code>
- <pre>Retrieves a report by its ID.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
-
-Returns:
- An object of the form:
-
- { # 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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Creates a report.
-
-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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # 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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)</code>
- <pre>Retrieves list of reports.
-
-Args:
- profileId: string, The DFA user 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 report ID.
- LAST_MODIFIED_TIME - Sort by 'lastModifiedTime' field.
- NAME - Sort by name of reports.
- scope: string, The scope that defines which results are returned, default is 'MINE'.
- Allowed values
- ALL - All reports in account.
- MINE - My reports.
-
-Returns:
- An object of the form:
-
- { # Represents the list of reports.
- "nextPageToken": "A String", # Continuation token used to page through reports. 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 reports returned in this response.
- { # 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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- },
- ],
- "kind": "dfareporting#reportList", # The kind of list this is, in this case dfareporting#reportList.
- "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>
-
-<div class="method">
- <code class="details" id="patch">patch(profileId, reportId, body)</code>
- <pre>Updates a report. This method supports patch semantics.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # 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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="run">run(profileId, reportId, synchronous=None)</code>
- <pre>Runs a report.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the report. (required)
- synchronous: boolean, If set and true, tries to run the report synchronously.
-
-Returns:
- An object of the form:
-
- { # Represents a File resource. A file contains the metadata 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.
- "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.
- },
- "fileName": "A String", # The filename 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="update">update(profileId, reportId, body)</code>
- <pre>Updates a report.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # 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.
- },
- ],
- "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.
- },
- "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.
- },
- ],
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subaccount 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.
- # 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. Note:
- # - "DAILY" also requires field "every" to be set.
- # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report. 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- },
- "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.
- },
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- },
- "fileName": "A String", # The filename used when generating report files for this report.
- "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.
- "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.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- "type": "A String", # The type of the report.
- "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.
- },
- ],
- "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.
- },
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.sites.html b/docs/dyn/dfareporting_v2_2.sites.html
deleted file mode 100644
index fb97c68..0000000
--- a/docs/dyn/dfareporting_v2_2.sites.html
+++ /dev/null
@@ -1,667 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.sites.html">sites</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one site by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new site.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None)</a></code></p>
-<p class="firstline">Retrieves a list of sites, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing site. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing site.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one site by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Site ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "firstName": "A String", # First name of this site contact.
- "title": "A String", # Title or designation of this site contact.
- "lastName": "A String", # Last name of this site contact.
- "address": "A String", # Address of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "phone": "A String", # Primary phone number of this site contact.
- "contactType": "A String", # Site contact type.
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new site.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "firstName": "A String", # First name of this site contact.
- "title": "A String", # Title or designation of this site contact.
- "lastName": "A String", # Last name of this site contact.
- "address": "A String", # Address of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "phone": "A String", # Primary phone number of this site contact.
- "contactType": "A String", # Site contact type.
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "firstName": "A String", # First name of this site contact.
- "title": "A String", # Title or designation of this site contact.
- "lastName": "A String", # Last name of this site contact.
- "address": "A String", # Address of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "phone": "A String", # Primary phone number of this site contact.
- "contactType": "A String", # Site contact type.
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None)</code>
- <pre>Retrieves a list of sites, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- unmappedSite: boolean, Select only sites that have not been mapped to a directory site.
- campaignIds: string, Select only sites with these campaign IDs. (repeated)
- acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
- pageToken: string, Value of the nextPageToken from the previous result page.
- acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
- maxResults: integer, Maximum number of results to return.
- adWordsSite: boolean, Select only AdWords sites.
- approved: boolean, Select only approved sites.
- searchString: string, Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site".
- subaccountId: string, Select only sites with this subaccount ID.
- directorySiteIds: string, Select only sites with these directory site IDs. (repeated)
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
- ids: string, Select only sites with these IDs. (repeated)
-
-Returns:
- An object of the form:
-
- { # Site List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#sitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
- "sites": [ # Site collection.
- { # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "firstName": "A String", # First name of this site contact.
- "title": "A String", # Title or designation of this site contact.
- "lastName": "A String", # Last name of this site contact.
- "address": "A String", # Address of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "phone": "A String", # Primary phone number of this site contact.
- "contactType": "A String", # Site contact type.
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing site. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Site ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "firstName": "A String", # First name of this site contact.
- "title": "A String", # Title or designation of this site contact.
- "lastName": "A String", # Last name of this site contact.
- "address": "A String", # Address of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "phone": "A String", # Primary phone number of this site contact.
- "contactType": "A String", # Site contact type.
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "firstName": "A String", # First name of this site contact.
- "title": "A String", # Title or designation of this site contact.
- "lastName": "A String", # Last name of this site contact.
- "address": "A String", # Address of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "phone": "A String", # Primary phone number of this site contact.
- "contactType": "A String", # Site contact type.
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing site.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "firstName": "A String", # First name of this site contact.
- "title": "A String", # Title or designation of this site contact.
- "lastName": "A String", # Last name of this site contact.
- "address": "A String", # Address of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "phone": "A String", # Primary phone number of this site contact.
- "contactType": "A String", # Site contact type.
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of a site.
- "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
- "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
- "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
- "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteSettings": { # Site Settings # Site-wide settings.
- "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
- "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
- "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
- "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
- },
- "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
- "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
- "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
- "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
- "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
- "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
- },
- "creativeSettings": { # Creative Settings # Site-wide creative settings.
- "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
- },
- },
- "approved": True or False, # Whether this site is approved.
- "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
- "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. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
- },
- "siteContacts": [ # Site contacts.
- { # Site Contact
- "firstName": "A String", # First name of this site contact.
- "title": "A String", # Title or designation of this site contact.
- "lastName": "A String", # Last name of this site contact.
- "address": "A String", # Address of this site contact.
- "email": "A String", # Email address of this site contact. This is a required field.
- "phone": "A String", # Primary phone number of this site contact.
- "contactType": "A String", # Site contact type.
- "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
- },
- ],
- "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
- "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
- "id": "A String", # ID of this site. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.userProfiles.html b/docs/dyn/dfareporting_v2_2.userProfiles.html
deleted file mode 100644
index d6f0695..0000000
--- a/docs/dyn/dfareporting_v2_2.userProfiles.html
+++ /dev/null
@@ -1,133 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.userProfiles.html">userProfiles</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId)</a></code></p>
-<p class="firstline">Gets one user profile by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list()</a></code></p>
-<p class="firstline">Retrieves list of user profiles for a user.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId)</code>
- <pre>Gets one user profile by ID.
-
-Args:
- profileId: string, The user profile ID. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a UserProfile resource.
- "userName": "A String", # The user name.
- "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
- "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
- "accountName": "A String", # The account name this profile belongs to.
- "etag": "A String", # The eTag of this response for caching purposes.
- "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
- "profileId": "A String", # The unique ID of the user profile.
- "accountId": "A String", # The account ID to which this profile belongs.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list()</code>
- <pre>Retrieves list of user profiles for a user.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # Represents the list of user profiles.
- "items": [ # The user profiles returned in this response.
- { # Represents a UserProfile resource.
- "userName": "A String", # The user name.
- "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
- "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
- "accountName": "A String", # The account name this profile belongs to.
- "etag": "A String", # The eTag of this response for caching purposes.
- "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
- "profileId": "A String", # The unique ID of the user profile.
- "accountId": "A String", # The account ID to which this profile belongs.
- },
- ],
- "kind": "dfareporting#userProfileList", # The kind of list this is, in this case dfareporting#userProfileList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.userRolePermissionGroups.html b/docs/dyn/dfareporting_v2_2.userRolePermissionGroups.html
deleted file mode 100644
index 8c22278..0000000
--- a/docs/dyn/dfareporting_v2_2.userRolePermissionGroups.html
+++ /dev/null
@@ -1,124 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.userRolePermissionGroups.html">userRolePermissionGroups</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one user role permission group by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId)</a></code></p>
-<p class="firstline">Gets a list of all supported user role permission groups.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one user role permission group by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User role permission group ID. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a grouping of related user role permissions.
- "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
- "id": "A String", # ID of this user role permission.
- "name": "A String", # Name of this user role permission group.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId)</code>
- <pre>Gets a list of all supported user role permission groups.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
-
-Returns:
- An object of the form:
-
- { # User Role Permission Group List Response
- "userRolePermissionGroups": [ # User role permission group collection.
- { # Represents a grouping of related user role permissions.
- "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
- "id": "A String", # ID of this user role permission.
- "name": "A String", # Name of this user role permission group.
- },
- ],
- "kind": "dfareporting#userRolePermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse".
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.userRolePermissions.html b/docs/dyn/dfareporting_v2_2.userRolePermissions.html
deleted file mode 100644
index a3580ce..0000000
--- a/docs/dyn/dfareporting_v2_2.userRolePermissions.html
+++ /dev/null
@@ -1,129 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.userRolePermissions.html">userRolePermissions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one user role permission by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, ids=None)</a></code></p>
-<p class="firstline">Gets a list of user role permissions, possibly filtered.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one user role permission by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User role permission ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, ids=None)</code>
- <pre>Gets a list of user role permissions, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- ids: string, Select only user role permissions with these IDs. (repeated)
-
-Returns:
- An object of the form:
-
- { # User Role Permission List Response
- "userRolePermissions": [ # User role permission collection.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "kind": "dfareporting#userRolePermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse".
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.userRoles.html b/docs/dyn/dfareporting_v2_2.userRoles.html
deleted file mode 100644
index 624c5f1..0000000
--- a/docs/dyn/dfareporting_v2_2.userRoles.html
+++ /dev/null
@@ -1,361 +0,0 @@
-<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_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.userRoles.html">userRoles</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing user role.</p>
-<p class="toc_element">
- <code><a href="#get">get(profileId, id)</a></code></p>
-<p class="firstline">Gets one user role by ID.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(profileId, body)</a></code></p>
-<p class="firstline">Inserts a new user role.</p>
-<p class="toc_element">
- <code><a href="#list">list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None)</a></code></p>
-<p class="firstline">Retrieves a list of user roles, possibly filtered.</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(profileId, id, body)</a></code></p>
-<p class="firstline">Updates an existing user role. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(profileId, body)</a></code></p>
-<p class="firstline">Updates an existing user role.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing user role.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User role ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(profileId, id)</code>
- <pre>Gets one user role by ID.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User role ID. (required)
-
-Returns:
- An object of the form:
-
- { # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(profileId, body)</code>
- <pre>Inserts a new user role.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None)</code>
- <pre>Retrieves a list of user roles, possibly filtered.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".
- subaccountId: string, Select only user roles that belong to this subaccount.
- pageToken: string, Value of the nextPageToken from the previous result page.
- ids: string, Select only user roles with the specified IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- accountUserRoleOnly: boolean, Select only account level user roles not associated with any specific subaccount.
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
- sortField: string, Field by which to sort the list.
- Allowed values
- ID -
- NAME -
-
-Returns:
- An object of the form:
-
- { # User Role List Response
- "nextPageToken": "A String", # Pagination token to be used for the next list operation.
- "kind": "dfareporting#userRolesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse".
- "userRoles": [ # User role collection.
- { # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- },
- ],
- }</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(profileId, id, body)</code>
- <pre>Updates an existing user role. This method supports patch semantics.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, User role ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(profileId, body)</code>
- <pre>Updates an existing user role.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }
-
-
-Returns:
- An object of the form:
-
- { # Contains properties of auser role, which is used to manage user access.
- "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
- "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
- "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
- "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
- "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
- "permissions": [ # List of permissions associated with this user role.
- { # Contains properties of a user role permission.
- "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
- "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
- "availability": "A String", # Levels of availability for a user role permission.
- "name": "A String", # Name of this user role permission.
- "id": "A String", # ID of this user role permission.
- },
- ],
- "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
- "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_4.ads.html b/docs/dyn/dfareporting_v2_4.ads.html
index b6ed0d3..4c795b6 100644
--- a/docs/dyn/dfareporting_v2_4.ads.html
+++ b/docs/dyn/dfareporting_v2_4.ads.html
@@ -111,7 +111,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -198,7 +198,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -222,7 +222,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -250,7 +250,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -341,7 +341,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -362,7 +362,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -377,16 +377,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -444,7 +444,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -531,7 +531,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -555,7 +555,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -583,7 +583,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -674,7 +674,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -695,7 +695,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -710,16 +710,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -771,7 +771,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -858,7 +858,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -882,7 +882,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -910,7 +910,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -1001,7 +1001,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -1022,7 +1022,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -1037,16 +1037,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -1175,7 +1175,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -1262,7 +1262,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -1286,7 +1286,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -1314,7 +1314,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -1405,7 +1405,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -1426,7 +1426,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -1441,16 +1441,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -1525,7 +1525,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -1612,7 +1612,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -1636,7 +1636,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -1664,7 +1664,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -1755,7 +1755,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -1776,7 +1776,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -1791,16 +1791,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -1852,7 +1852,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -1939,7 +1939,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -1963,7 +1963,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -1991,7 +1991,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -2082,7 +2082,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -2103,7 +2103,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -2118,16 +2118,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -2185,7 +2185,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -2272,7 +2272,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -2296,7 +2296,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -2324,7 +2324,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -2415,7 +2415,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -2436,7 +2436,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -2451,16 +2451,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -2512,7 +2512,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -2599,7 +2599,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -2623,7 +2623,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -2651,7 +2651,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -2742,7 +2742,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -2763,7 +2763,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -2778,16 +2778,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
diff --git a/docs/dyn/dfareporting_v2_4.changeLogs.html b/docs/dyn/dfareporting_v2_4.changeLogs.html
index 8fb7107..96274ce 100644
--- a/docs/dyn/dfareporting_v2_4.changeLogs.html
+++ b/docs/dyn/dfareporting_v2_4.changeLogs.html
@@ -155,6 +155,7 @@
OBJECT_SD_SITE -
OBJECT_SIZE -
OBJECT_SUBACCOUNT -
+ OBJECT_TARGETING_TEMPLATE -
OBJECT_USER_PROFILE -
OBJECT_USER_PROFILE_FILTER -
OBJECT_USER_ROLE -
diff --git a/docs/dyn/dfareporting_v2_4.creativeAssets.html b/docs/dyn/dfareporting_v2_4.creativeAssets.html
index c1e40f6..5898e9f 100644
--- a/docs/dyn/dfareporting_v2_4.creativeAssets.html
+++ b/docs/dyn/dfareporting_v2_4.creativeAssets.html
@@ -92,32 +92,35 @@
"warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
#
# Possible values are:
- # - "CLICK_TAG_NON_TOP_LEVEL"
+ # - "ADMOB_REFERENCED"
+ # - "ASSET_FORMAT_UNSUPPORTED_DCM"
+ # - "ASSET_INVALID"
+ # - "CLICK_TAG_HARD_CODED"
+ # - "CLICK_TAG_INVALID"
+ # - "CLICK_TAG_IN_GWD"
# - "CLICK_TAG_MISSING"
# - "CLICK_TAG_MORE_THAN_ONE"
- # - "CLICK_TAG_INVALID"
- # - "ORPHANED_ASSET"
- # - "PRIMARY_HTML_MISSING"
+ # - "CLICK_TAG_NON_TOP_LEVEL"
+ # - "COMPONENT_UNSUPPORTED_DCM"
+ # - "ENABLER_UNSUPPORTED_METHOD_DCM"
# - "EXTERNAL_FILE_REFERENCED"
- # - "MRAID_REFERENCED"
- # - "ADMOB_REFERENCED"
+ # - "FILE_DETAIL_EMPTY"
# - "FILE_TYPE_INVALID"
- # - "ZIP_INVALID"
+ # - "GWD_PROPERTIES_INVALID"
+ # - "HTML5_FEATURE_UNSUPPORTED"
# - "LINKED_FILE_NOT_FOUND"
# - "MAX_FLASH_VERSION_11"
+ # - "MRAID_REFERENCED"
# - "NOT_SSL_COMPLIANT"
- # - "FILE_DETAIL_EMPTY"
- # - "ASSET_INVALID"
- # - "GWD_PROPERTIES_INVALID"
- # - "ENABLER_UNSUPPORTED_METHOD_DCM"
- # - "ASSET_FORMAT_UNSUPPORTED_DCM"
- # - "COMPONENT_UNSUPPORTED_DCM"
- # - "HTML5_FEATURE_UNSUPPORTED' "
+ # - "ORPHANED_ASSET"
+ # - "PRIMARY_HTML_MISSING"
+ # - "SVG_INVALID"
+ # - "ZIP_INVALID"
"A String",
],
"clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
@@ -141,32 +144,35 @@
"warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
#
# Possible values are:
- # - "CLICK_TAG_NON_TOP_LEVEL"
+ # - "ADMOB_REFERENCED"
+ # - "ASSET_FORMAT_UNSUPPORTED_DCM"
+ # - "ASSET_INVALID"
+ # - "CLICK_TAG_HARD_CODED"
+ # - "CLICK_TAG_INVALID"
+ # - "CLICK_TAG_IN_GWD"
# - "CLICK_TAG_MISSING"
# - "CLICK_TAG_MORE_THAN_ONE"
- # - "CLICK_TAG_INVALID"
- # - "ORPHANED_ASSET"
- # - "PRIMARY_HTML_MISSING"
+ # - "CLICK_TAG_NON_TOP_LEVEL"
+ # - "COMPONENT_UNSUPPORTED_DCM"
+ # - "ENABLER_UNSUPPORTED_METHOD_DCM"
# - "EXTERNAL_FILE_REFERENCED"
- # - "MRAID_REFERENCED"
- # - "ADMOB_REFERENCED"
+ # - "FILE_DETAIL_EMPTY"
# - "FILE_TYPE_INVALID"
- # - "ZIP_INVALID"
+ # - "GWD_PROPERTIES_INVALID"
+ # - "HTML5_FEATURE_UNSUPPORTED"
# - "LINKED_FILE_NOT_FOUND"
# - "MAX_FLASH_VERSION_11"
+ # - "MRAID_REFERENCED"
# - "NOT_SSL_COMPLIANT"
- # - "FILE_DETAIL_EMPTY"
- # - "ASSET_INVALID"
- # - "GWD_PROPERTIES_INVALID"
- # - "ENABLER_UNSUPPORTED_METHOD_DCM"
- # - "ASSET_FORMAT_UNSUPPORTED_DCM"
- # - "COMPONENT_UNSUPPORTED_DCM"
- # - "HTML5_FEATURE_UNSUPPORTED' "
+ # - "ORPHANED_ASSET"
+ # - "PRIMARY_HTML_MISSING"
+ # - "SVG_INVALID"
+ # - "ZIP_INVALID"
"A String",
],
"clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
diff --git a/docs/dyn/dfareporting_v2_4.creatives.html b/docs/dyn/dfareporting_v2_4.creatives.html
index 985823e..bb0b809 100644
--- a/docs/dyn/dfareporting_v2_4.creatives.html
+++ b/docs/dyn/dfareporting_v2_4.creatives.html
@@ -116,8 +116,8 @@
"videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -171,8 +171,8 @@
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
"authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -239,7 +239,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -260,7 +260,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -269,7 +269,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -283,7 +283,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -293,7 +293,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -318,7 +318,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -369,7 +369,7 @@
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -387,17 +387,17 @@
"redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -418,7 +418,7 @@
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
@@ -427,10 +427,10 @@
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
@@ -459,8 +459,8 @@
"videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -514,8 +514,8 @@
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
"authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -582,7 +582,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -603,7 +603,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -612,7 +612,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -626,7 +626,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -636,7 +636,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -661,7 +661,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -712,7 +712,7 @@
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -730,17 +730,17 @@
"redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -761,7 +761,7 @@
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
@@ -770,10 +770,10 @@
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
@@ -796,8 +796,8 @@
"videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -851,8 +851,8 @@
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
"authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -919,7 +919,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -940,7 +940,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -949,7 +949,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -963,7 +963,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -973,7 +973,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -998,7 +998,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -1049,7 +1049,7 @@
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -1067,17 +1067,17 @@
"redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -1098,7 +1098,7 @@
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
@@ -1107,10 +1107,10 @@
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
@@ -1191,8 +1191,8 @@
"videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -1246,8 +1246,8 @@
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
"authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -1314,7 +1314,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -1335,7 +1335,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -1344,7 +1344,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -1358,7 +1358,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -1368,7 +1368,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -1393,7 +1393,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -1444,7 +1444,7 @@
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -1462,17 +1462,17 @@
"redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -1493,7 +1493,7 @@
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
@@ -1502,10 +1502,10 @@
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
@@ -1551,8 +1551,8 @@
"videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -1606,8 +1606,8 @@
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
"authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -1674,7 +1674,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -1695,7 +1695,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -1704,7 +1704,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -1718,7 +1718,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -1728,7 +1728,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -1753,7 +1753,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -1804,7 +1804,7 @@
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -1822,17 +1822,17 @@
"redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -1853,7 +1853,7 @@
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
@@ -1862,10 +1862,10 @@
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
@@ -1888,8 +1888,8 @@
"videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -1943,8 +1943,8 @@
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
"authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -2011,7 +2011,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -2032,7 +2032,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -2041,7 +2041,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -2055,7 +2055,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -2065,7 +2065,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -2090,7 +2090,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -2141,7 +2141,7 @@
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -2159,17 +2159,17 @@
"redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -2190,7 +2190,7 @@
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
@@ -2199,10 +2199,10 @@
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
@@ -2231,8 +2231,8 @@
"videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -2286,8 +2286,8 @@
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
"authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -2354,7 +2354,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -2375,7 +2375,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -2384,7 +2384,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -2398,7 +2398,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -2408,7 +2408,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -2433,7 +2433,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -2484,7 +2484,7 @@
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -2502,17 +2502,17 @@
"redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -2533,7 +2533,7 @@
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
@@ -2542,10 +2542,10 @@
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
@@ -2568,8 +2568,8 @@
"videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -2623,8 +2623,8 @@
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
"authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
@@ -2691,7 +2691,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -2712,7 +2712,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -2721,7 +2721,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -2735,7 +2735,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -2745,7 +2745,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -2770,7 +2770,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -2821,7 +2821,7 @@
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -2839,17 +2839,17 @@
"redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -2870,7 +2870,7 @@
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
@@ -2879,10 +2879,10 @@
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
diff --git a/docs/dyn/dfareporting_v2_4.placementGroups.html b/docs/dyn/dfareporting_v2_4.placementGroups.html
index c76ce19..310997e 100644
--- a/docs/dyn/dfareporting_v2_4.placementGroups.html
+++ b/docs/dyn/dfareporting_v2_4.placementGroups.html
@@ -420,6 +420,7 @@
PRICING_TYPE_CPA -
PRICING_TYPE_CPC -
PRICING_TYPE_CPM -
+ PRICING_TYPE_CPM_ACTIVEVIEW -
PRICING_TYPE_FLAT_RATE_CLICKS -
PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
diff --git a/docs/dyn/dfareporting_v2_4.placements.html b/docs/dyn/dfareporting_v2_4.placements.html
index d3fcbd7..7e04a57 100644
--- a/docs/dyn/dfareporting_v2_4.placements.html
+++ b/docs/dyn/dfareporting_v2_4.placements.html
@@ -252,7 +252,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -397,7 +397,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -536,7 +536,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -594,6 +594,7 @@
PRICING_TYPE_CPA -
PRICING_TYPE_CPC -
PRICING_TYPE_CPM -
+ PRICING_TYPE_CPM_ACTIVEVIEW -
PRICING_TYPE_FLAT_RATE_CLICKS -
PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
campaignIds: string, Select only placements that belong to these campaigns. (repeated)
@@ -611,7 +612,7 @@
archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
maxResults: integer, Maximum number of results to return.
minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
- compatibilities: string, Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. (repeated)
+ compatibilities: string, Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. (repeated)
Allowed values
APP -
APP_INTERSTITIAL -
@@ -729,7 +730,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -891,7 +892,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -1030,7 +1031,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -1175,7 +1176,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -1314,7 +1315,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
diff --git a/docs/dyn/dfareporting_v2_5.ads.html b/docs/dyn/dfareporting_v2_5.ads.html
index 9040be8..f9600f6 100644
--- a/docs/dyn/dfareporting_v2_5.ads.html
+++ b/docs/dyn/dfareporting_v2_5.ads.html
@@ -111,7 +111,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -198,7 +198,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -222,7 +222,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -250,7 +250,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -341,7 +341,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -362,7 +362,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -377,7 +377,7 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
@@ -386,7 +386,7 @@
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -444,7 +444,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -531,7 +531,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -555,7 +555,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -583,7 +583,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -674,7 +674,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -695,7 +695,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -710,7 +710,7 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
@@ -719,7 +719,7 @@
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -771,7 +771,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -858,7 +858,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -882,7 +882,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -910,7 +910,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -1001,7 +1001,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -1022,7 +1022,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -1037,7 +1037,7 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
@@ -1046,7 +1046,7 @@
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -1175,7 +1175,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -1262,7 +1262,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -1286,7 +1286,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -1314,7 +1314,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -1405,7 +1405,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -1426,7 +1426,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -1441,7 +1441,7 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
@@ -1450,7 +1450,7 @@
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -1525,7 +1525,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -1612,7 +1612,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -1636,7 +1636,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -1664,7 +1664,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -1755,7 +1755,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -1776,7 +1776,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -1791,7 +1791,7 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
@@ -1800,7 +1800,7 @@
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -1852,7 +1852,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -1939,7 +1939,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -1963,7 +1963,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -1991,7 +1991,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -2082,7 +2082,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -2103,7 +2103,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -2118,7 +2118,7 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
@@ -2127,7 +2127,7 @@
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -2185,7 +2185,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -2272,7 +2272,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -2296,7 +2296,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -2324,7 +2324,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -2415,7 +2415,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -2436,7 +2436,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -2451,7 +2451,7 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
@@ -2460,7 +2460,7 @@
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -2512,7 +2512,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -2599,7 +2599,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -2623,7 +2623,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -2651,7 +2651,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -2742,7 +2742,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -2763,7 +2763,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -2778,7 +2778,7 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
@@ -2787,7 +2787,7 @@
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
diff --git a/docs/dyn/dfareporting_v2_5.changeLogs.html b/docs/dyn/dfareporting_v2_5.changeLogs.html
index 0380f2c..9b231af 100644
--- a/docs/dyn/dfareporting_v2_5.changeLogs.html
+++ b/docs/dyn/dfareporting_v2_5.changeLogs.html
@@ -155,6 +155,7 @@
OBJECT_SD_SITE -
OBJECT_SIZE -
OBJECT_SUBACCOUNT -
+ OBJECT_TARGETING_TEMPLATE -
OBJECT_USER_PROFILE -
OBJECT_USER_PROFILE_FILTER -
OBJECT_USER_ROLE -
diff --git a/docs/dyn/dfareporting_v2_5.conversions.html b/docs/dyn/dfareporting_v2_5.conversions.html
index e4e0f1d..0fbc3e5 100644
--- a/docs/dyn/dfareporting_v2_5.conversions.html
+++ b/docs/dyn/dfareporting_v2_5.conversions.html
@@ -94,7 +94,7 @@
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
"kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
"childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
- "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with mobileDeviceId. This or mobileDeviceId is a required field.
+ "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
"customVariables": [ # Custom floodlight variables.
{ # A custom floodlight variable.
"kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
@@ -107,7 +107,7 @@
"limitAdTracking": True or False, # Whether the user has Limit Ad Tracking set.
"quantity": "A String", # The quantity of the conversion.
"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
- "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId. This or encryptedUserId is a required field.
+ "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
},
],
"kind": "dfareporting#conversionsBatchInsertRequest", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest".
@@ -125,13 +125,13 @@
{ # Insert Conversions Response.
"status": [ # The status of each conversion's insertion status. The status is returned in the same order that conversions are inserted.
- { # The original conversion that was inserted and whether there were any errors.
- "conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted.
+ { # The original conversion that was inserted or updated and whether there were any errors.
+ "conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
"ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
"kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
"childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
- "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with mobileDeviceId. This or mobileDeviceId is a required field.
+ "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
"customVariables": [ # Custom floodlight variables.
{ # A custom floodlight variable.
"kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
@@ -144,10 +144,10 @@
"limitAdTracking": True or False, # Whether the user has Limit Ad Tracking set.
"quantity": "A String", # The quantity of the conversion.
"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
- "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId. This or encryptedUserId is a required field.
+ "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
},
"errors": [ # A list of errors related to this conversion.
- { # The error code and description for a conversion that failed to insert.
+ { # The error code and description for a conversion that failed to insert or update.
"kind": "dfareporting#conversionError", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
"code": "A String", # The error code.
"message": "A String", # A description of the error.
diff --git a/docs/dyn/dfareporting_v2_5.creativeAssets.html b/docs/dyn/dfareporting_v2_5.creativeAssets.html
index 240ce6d..fbc2e7f 100644
--- a/docs/dyn/dfareporting_v2_5.creativeAssets.html
+++ b/docs/dyn/dfareporting_v2_5.creativeAssets.html
@@ -120,8 +120,8 @@
],
"clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
@@ -172,8 +172,8 @@
],
"clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
diff --git a/docs/dyn/dfareporting_v2_5.creatives.html b/docs/dyn/dfareporting_v2_5.creatives.html
index cdcaa77..86a9d50 100644
--- a/docs/dyn/dfareporting_v2_5.creatives.html
+++ b/docs/dyn/dfareporting_v2_5.creatives.html
@@ -390,14 +390,14 @@
"convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -426,7 +426,7 @@
"companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
"backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"A String",
],
@@ -733,14 +733,14 @@
"convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -769,7 +769,7 @@
"companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
"backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"A String",
],
@@ -1070,14 +1070,14 @@
"convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -1106,7 +1106,7 @@
"companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
"backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"A String",
],
@@ -1465,14 +1465,14 @@
"convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -1501,7 +1501,7 @@
"companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
"backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"A String",
],
@@ -1825,14 +1825,14 @@
"convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -1861,7 +1861,7 @@
"companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
"backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"A String",
],
@@ -2162,14 +2162,14 @@
"convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -2198,7 +2198,7 @@
"companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
"backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"A String",
],
@@ -2505,14 +2505,14 @@
"convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -2541,7 +2541,7 @@
"companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
"backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"A String",
],
@@ -2842,14 +2842,14 @@
"convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
- "name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
"commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
@@ -2878,7 +2878,7 @@
"companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
- "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "auto_advance_images": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
"backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
"A String",
],
diff --git a/docs/dyn/dfareporting_v2_5.placementGroups.html b/docs/dyn/dfareporting_v2_5.placementGroups.html
index 4f98066..779a59d 100644
--- a/docs/dyn/dfareporting_v2_5.placementGroups.html
+++ b/docs/dyn/dfareporting_v2_5.placementGroups.html
@@ -420,6 +420,7 @@
PRICING_TYPE_CPA -
PRICING_TYPE_CPC -
PRICING_TYPE_CPM -
+ PRICING_TYPE_CPM_ACTIVEVIEW -
PRICING_TYPE_FLAT_RATE_CLICKS -
PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
diff --git a/docs/dyn/dfareporting_v2_5.placements.html b/docs/dyn/dfareporting_v2_5.placements.html
index 4124035..c9ca3f0 100644
--- a/docs/dyn/dfareporting_v2_5.placements.html
+++ b/docs/dyn/dfareporting_v2_5.placements.html
@@ -594,6 +594,7 @@
PRICING_TYPE_CPA -
PRICING_TYPE_CPC -
PRICING_TYPE_CPM -
+ PRICING_TYPE_CPM_ACTIVEVIEW -
PRICING_TYPE_FLAT_RATE_CLICKS -
PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
campaignIds: string, Select only placements that belong to these campaigns. (repeated)
diff --git a/docs/dyn/dfareporting_v2_1.accountActiveAdSummaries.html b/docs/dyn/dfareporting_v2_5beta1.accountActiveAdSummaries.html
similarity index 91%
rename from docs/dyn/dfareporting_v2_1.accountActiveAdSummaries.html
rename to docs/dyn/dfareporting_v2_5beta1.accountActiveAdSummaries.html
index 5436386..e99a7fc 100644
--- a/docs/dyn/dfareporting_v2_1.accountActiveAdSummaries.html
+++ b/docs/dyn/dfareporting_v2_5beta1.accountActiveAdSummaries.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.accountActiveAdSummaries.html">accountActiveAdSummaries</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.accountActiveAdSummaries.html">accountActiveAdSummaries</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, summaryAccountId)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.accountPermissionGroups.html b/docs/dyn/dfareporting_v2_5beta1.accountPermissionGroups.html
similarity index 94%
rename from docs/dyn/dfareporting_v2_1.accountPermissionGroups.html
rename to docs/dyn/dfareporting_v2_5beta1.accountPermissionGroups.html
index df69894..b71b2d2 100644
--- a/docs/dyn/dfareporting_v2_1.accountPermissionGroups.html
+++ b/docs/dyn/dfareporting_v2_5beta1.accountPermissionGroups.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.accountPermissionGroups.html">accountPermissionGroups</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.accountPermissionGroups.html">accountPermissionGroups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.accountPermissions.html b/docs/dyn/dfareporting_v2_5beta1.accountPermissions.html
similarity index 95%
rename from docs/dyn/dfareporting_v2_2.accountPermissions.html
rename to docs/dyn/dfareporting_v2_5beta1.accountPermissions.html
index f31d6b5..0e95c45 100644
--- a/docs/dyn/dfareporting_v2_2.accountPermissions.html
+++ b/docs/dyn/dfareporting_v2_5beta1.accountPermissions.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.accountPermissions.html">accountPermissions</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.accountPermissions.html">accountPermissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.accountUserProfiles.html b/docs/dyn/dfareporting_v2_5beta1.accountUserProfiles.html
similarity index 99%
rename from docs/dyn/dfareporting_v2_1.accountUserProfiles.html
rename to docs/dyn/dfareporting_v2_5beta1.accountUserProfiles.html
index 5df4535..61f339f 100644
--- a/docs/dyn/dfareporting_v2_1.accountUserProfiles.html
+++ b/docs/dyn/dfareporting_v2_5beta1.accountUserProfiles.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.accountUserProfiles.html">accountUserProfiles</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.accountUserProfiles.html">accountUserProfiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_0.accounts.html b/docs/dyn/dfareporting_v2_5beta1.accounts.html
similarity index 94%
rename from docs/dyn/dfareporting_v2_0.accounts.html
rename to docs/dyn/dfareporting_v2_5beta1.accounts.html
index fa9ede9..0425606 100644
--- a/docs/dyn/dfareporting_v2_0.accounts.html
+++ b/docs/dyn/dfareporting_v2_5beta1.accounts.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.accounts.html">accounts</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
@@ -147,6 +147,17 @@
# - "34" for VEF
# - "35" for COP
# - "36" for GTQ
+ # - "37" for PLN
+ # - "39" for INR
+ # - "40" for THB
+ # - "41" for IDR
+ # - "42" for CZK
+ # - "43" for RON
+ # - "44" for HUF
+ # - "45" for RUB
+ # - "46" for AED
+ # - "47" for BGN
+ # - "48" for HRK
"defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
"accountPermissionIds": [ # Account permissions assigned to this account.
"A String",
@@ -210,7 +221,7 @@
Args:
profileId: string, User profile ID associated with this request. (required)
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015" or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015" or simply "account".
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
sortField: string, Field by which to sort the list.
Allowed values
ID -
@@ -230,7 +241,7 @@
{ # Account List Response
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"kind": "dfareporting#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse".
- "accounts": [ # Account collection
+ "accounts": [ # Account collection.
{ # Contains properties of a DCM account.
"kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
"countryId": "A String", # ID of the country associated with this account.
@@ -277,6 +288,17 @@
# - "34" for VEF
# - "35" for COP
# - "36" for GTQ
+ # - "37" for PLN
+ # - "39" for INR
+ # - "40" for THB
+ # - "41" for IDR
+ # - "42" for CZK
+ # - "43" for RON
+ # - "44" for HUF
+ # - "45" for RUB
+ # - "46" for AED
+ # - "47" for BGN
+ # - "48" for HRK
"defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
"accountPermissionIds": [ # Account permissions assigned to this account.
"A String",
@@ -406,6 +428,17 @@
# - "34" for VEF
# - "35" for COP
# - "36" for GTQ
+ # - "37" for PLN
+ # - "39" for INR
+ # - "40" for THB
+ # - "41" for IDR
+ # - "42" for CZK
+ # - "43" for RON
+ # - "44" for HUF
+ # - "45" for RUB
+ # - "46" for AED
+ # - "47" for BGN
+ # - "48" for HRK
"defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
"accountPermissionIds": [ # Account permissions assigned to this account.
"A String",
@@ -512,6 +545,17 @@
# - "34" for VEF
# - "35" for COP
# - "36" for GTQ
+ # - "37" for PLN
+ # - "39" for INR
+ # - "40" for THB
+ # - "41" for IDR
+ # - "42" for CZK
+ # - "43" for RON
+ # - "44" for HUF
+ # - "45" for RUB
+ # - "46" for AED
+ # - "47" for BGN
+ # - "48" for HRK
"defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
"accountPermissionIds": [ # Account permissions assigned to this account.
"A String",
@@ -624,6 +668,17 @@
# - "34" for VEF
# - "35" for COP
# - "36" for GTQ
+ # - "37" for PLN
+ # - "39" for INR
+ # - "40" for THB
+ # - "41" for IDR
+ # - "42" for CZK
+ # - "43" for RON
+ # - "44" for HUF
+ # - "45" for RUB
+ # - "46" for AED
+ # - "47" for BGN
+ # - "48" for HRK
"defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
"accountPermissionIds": [ # Account permissions assigned to this account.
"A String",
@@ -730,6 +785,17 @@
# - "34" for VEF
# - "35" for COP
# - "36" for GTQ
+ # - "37" for PLN
+ # - "39" for INR
+ # - "40" for THB
+ # - "41" for IDR
+ # - "42" for CZK
+ # - "43" for RON
+ # - "44" for HUF
+ # - "45" for RUB
+ # - "46" for AED
+ # - "47" for BGN
+ # - "48" for HRK
"defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
"accountPermissionIds": [ # Account permissions assigned to this account.
"A String",
diff --git a/docs/dyn/dfareporting_v2_2.ads.html b/docs/dyn/dfareporting_v2_5beta1.ads.html
similarity index 94%
rename from docs/dyn/dfareporting_v2_2.ads.html
rename to docs/dyn/dfareporting_v2_5beta1.ads.html
index c115007..6cb5310 100644
--- a/docs/dyn/dfareporting_v2_2.ads.html
+++ b/docs/dyn/dfareporting_v2_5beta1.ads.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.ads.html">ads</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.ads.html">ads</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
@@ -111,7 +111,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -198,7 +198,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -222,7 +222,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -250,7 +250,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -341,7 +341,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -362,7 +362,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -377,16 +377,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -444,7 +444,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -531,7 +531,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -555,7 +555,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -583,7 +583,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -674,7 +674,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -695,7 +695,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -710,16 +710,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -771,7 +771,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -858,7 +858,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -882,7 +882,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -910,7 +910,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -1001,7 +1001,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -1022,7 +1022,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -1037,16 +1037,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -1127,6 +1127,7 @@
HTML5_BANNER -
IMAGE -
INSTREAM_VIDEO -
+ INSTREAM_VIDEO_REDIRECT -
INTERNAL_REDIRECT -
INTERSTITIAL_INTERNAL_REDIRECT -
REDIRECT -
@@ -1139,18 +1140,17 @@
RICH_MEDIA_MULTI_FLOATING -
RICH_MEDIA_PEEL_DOWN -
TRACKING_TEXT -
- VAST_REDIRECT -
VPAID_LINEAR -
VPAID_NON_LINEAR -
placementIds: string, Select only ads with these placement IDs assigned. (repeated)
active: boolean, Select only active ads.
- compatibility: string, Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
+ compatibility: string, Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
Allowed values
APP -
APP_INTERSTITIAL -
+ DISPLAY -
+ DISPLAY_INTERSTITIAL -
IN_STREAM_VIDEO -
- WEB -
- WEB_INTERSTITIAL -
advertiserId: string, Select only ads with this advertiser ID.
searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
audienceSegmentIds: string, Select only ads with these audience segment IDs. (repeated)
@@ -1175,7 +1175,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -1262,7 +1262,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -1286,7 +1286,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -1314,7 +1314,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -1405,7 +1405,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -1426,7 +1426,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -1441,16 +1441,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -1525,7 +1525,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -1612,7 +1612,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -1636,7 +1636,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -1664,7 +1664,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -1755,7 +1755,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -1776,7 +1776,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -1791,16 +1791,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -1852,7 +1852,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -1939,7 +1939,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -1963,7 +1963,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -1991,7 +1991,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -2082,7 +2082,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -2103,7 +2103,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -2118,16 +2118,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -2185,7 +2185,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -2272,7 +2272,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -2296,7 +2296,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -2324,7 +2324,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -2415,7 +2415,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -2436,7 +2436,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -2451,16 +2451,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
@@ -2512,7 +2512,7 @@
},
"campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
"advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
- "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
{ # Contains information about a country that can be targeted by ads.
"dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
@@ -2599,7 +2599,7 @@
"id": "A String", # ID of this ad. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
"archived": True or False, # Whether this ad is archived.
- "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a platform type that can be targeted by ads.
"kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
@@ -2623,7 +2623,7 @@
"minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
},
],
- "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about a browser that can be targeted by ads.
"majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
"kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
@@ -2651,7 +2651,7 @@
"name": "A String", # Name of this mobile carrier.
},
],
- "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
{ # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
"kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
"id": "A String", # ID of this connection type.
@@ -2742,7 +2742,7 @@
"defaultLandingPage": True or False, # Whether the campaign default landing page is used.
},
"comments": "A String", # Comments for this ad.
- "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Expression describing which lists are being targeted by the ad.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
@@ -2763,7 +2763,7 @@
"type": "A String", # Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
"sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
"audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
- "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"expression": "A String", # Keyword expression being targeted by the ad.
},
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
@@ -2778,16 +2778,16 @@
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
- "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"startTime": "A String", # Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
"active": True or False, # Whether this ad is active.
- "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
"kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
"subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
"name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
- "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
"userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
"hoursOfDay": [ # Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.
42,
diff --git a/docs/dyn/dfareporting_v2_1.advertiserGroups.html b/docs/dyn/dfareporting_v2_5beta1.advertiserGroups.html
similarity index 98%
rename from docs/dyn/dfareporting_v2_1.advertiserGroups.html
rename to docs/dyn/dfareporting_v2_5beta1.advertiserGroups.html
index 247626e..6e166c2 100644
--- a/docs/dyn/dfareporting_v2_1.advertiserGroups.html
+++ b/docs/dyn/dfareporting_v2_5beta1.advertiserGroups.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.advertiserGroups.html">advertiserGroups</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.advertiserGroups.html">advertiserGroups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.advertisers.html b/docs/dyn/dfareporting_v2_5beta1.advertisers.html
similarity index 99%
rename from docs/dyn/dfareporting_v2_2.advertisers.html
rename to docs/dyn/dfareporting_v2_5beta1.advertisers.html
index 4408df9..f457eaf 100644
--- a/docs/dyn/dfareporting_v2_2.advertisers.html
+++ b/docs/dyn/dfareporting_v2_5beta1.advertisers.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.advertisers.html">advertisers</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.advertisers.html">advertisers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.browsers.html b/docs/dyn/dfareporting_v2_5beta1.browsers.html
similarity index 95%
rename from docs/dyn/dfareporting_v2_1.browsers.html
rename to docs/dyn/dfareporting_v2_5beta1.browsers.html
index 1d56d3b..4184f8f 100644
--- a/docs/dyn/dfareporting_v2_1.browsers.html
+++ b/docs/dyn/dfareporting_v2_5beta1.browsers.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.browsers.html">browsers</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.browsers.html">browsers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(profileId)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_0.campaignCreativeAssociations.html b/docs/dyn/dfareporting_v2_5beta1.campaignCreativeAssociations.html
similarity index 96%
rename from docs/dyn/dfareporting_v2_0.campaignCreativeAssociations.html
rename to docs/dyn/dfareporting_v2_5beta1.campaignCreativeAssociations.html
index ba90129..471cd2d 100644
--- a/docs/dyn/dfareporting_v2_0.campaignCreativeAssociations.html
+++ b/docs/dyn/dfareporting_v2_5beta1.campaignCreativeAssociations.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.campaignCreativeAssociations.html">campaignCreativeAssociations</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.campaignCreativeAssociations.html">campaignCreativeAssociations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#insert">insert(profileId, campaignId, body)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.campaigns.html b/docs/dyn/dfareporting_v2_5beta1.campaigns.html
similarity index 99%
rename from docs/dyn/dfareporting_v2_2.campaigns.html
rename to docs/dyn/dfareporting_v2_5beta1.campaigns.html
index 159fafa..d73ed76 100644
--- a/docs/dyn/dfareporting_v2_2.campaigns.html
+++ b/docs/dyn/dfareporting_v2_5beta1.campaigns.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.campaigns.html">campaigns</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.campaigns.html">campaigns</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.changeLogs.html b/docs/dyn/dfareporting_v2_5beta1.changeLogs.html
similarity index 97%
rename from docs/dyn/dfareporting_v2_2.changeLogs.html
rename to docs/dyn/dfareporting_v2_5beta1.changeLogs.html
index 9f5f045..6e41f96 100644
--- a/docs/dyn/dfareporting_v2_2.changeLogs.html
+++ b/docs/dyn/dfareporting_v2_5beta1.changeLogs.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.changeLogs.html">changeLogs</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.changeLogs.html">changeLogs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
@@ -147,6 +147,7 @@
OBJECT_MEDIA_ORDER -
OBJECT_PLACEMENT -
OBJECT_PLACEMENT_STRATEGY -
+ OBJECT_PLAYSTORE_LINK -
OBJECT_PROVIDED_LIST_CLIENT -
OBJECT_RATE_CARD -
OBJECT_REMARKETING_LIST -
@@ -154,6 +155,7 @@
OBJECT_SD_SITE -
OBJECT_SIZE -
OBJECT_SUBACCOUNT -
+ OBJECT_TARGETING_TEMPLATE -
OBJECT_USER_PROFILE -
OBJECT_USER_PROFILE_FILTER -
OBJECT_USER_ROLE -
diff --git a/docs/dyn/dfareporting_v2_1.cities.html b/docs/dyn/dfareporting_v2_5beta1.cities.html
similarity index 95%
rename from docs/dyn/dfareporting_v2_1.cities.html
rename to docs/dyn/dfareporting_v2_5beta1.cities.html
index 71a2cd5..993bf9e 100644
--- a/docs/dyn/dfareporting_v2_1.cities.html
+++ b/docs/dyn/dfareporting_v2_5beta1.cities.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.cities.html">cities</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.cities.html">cities</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.connectionTypes.html b/docs/dyn/dfareporting_v2_5beta1.connectionTypes.html
similarity index 94%
rename from docs/dyn/dfareporting_v2_2.connectionTypes.html
rename to docs/dyn/dfareporting_v2_5beta1.connectionTypes.html
index 8dff271..7077c0e 100644
--- a/docs/dyn/dfareporting_v2_2.connectionTypes.html
+++ b/docs/dyn/dfareporting_v2_5beta1.connectionTypes.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.connectionTypes.html">connectionTypes</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.connectionTypes.html">connectionTypes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.contentCategories.html b/docs/dyn/dfareporting_v2_5beta1.contentCategories.html
similarity index 98%
rename from docs/dyn/dfareporting_v2_1.contentCategories.html
rename to docs/dyn/dfareporting_v2_5beta1.contentCategories.html
index d69a3c7..b6a9889 100644
--- a/docs/dyn/dfareporting_v2_1.contentCategories.html
+++ b/docs/dyn/dfareporting_v2_5beta1.contentCategories.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.contentCategories.html">contentCategories</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.contentCategories.html">contentCategories</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_5beta1.conversions.html b/docs/dyn/dfareporting_v2_5beta1.conversions.html
new file mode 100644
index 0000000..10fabe0
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_5beta1.conversions.html
@@ -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="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.conversions.html">conversions</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#batchinsert">batchinsert(profileId, body)</a></code></p>
+<p class="firstline">Inserts conversions.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="batchinsert">batchinsert(profileId, body)</code>
+ <pre>Inserts conversions.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Insert Conversions Request.
+ "conversions": [ # The set of conversions to insert.
+ { # A Conversion represents when a user successfully performs a desired action after seeing an ad.
+ "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
+ "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
+ "kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
+ "childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
+ "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
+ "customVariables": [ # Custom floodlight variables.
+ { # A custom floodlight variable.
+ "kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
+ "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
+ "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
+ },
+ ],
+ "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
+ "value": 3.14, # The value of the conversion.
+ "limitAdTracking": True or False, # Whether the user has Limit Ad Tracking set.
+ "quantity": "A String", # The quantity of the conversion.
+ "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
+ "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
+ },
+ ],
+ "kind": "dfareporting#conversionsBatchInsertRequest", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest".
+ "encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used.
+ "kind": "dfareporting#encryptionInfo", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
+ "encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
+ "encryptionSource": "A String", # Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
+ "encryptionEntityType": "A String", # The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Insert Conversions Response.
+ "status": [ # The status of each conversion's insertion status. The status is returned in the same order that conversions are inserted.
+ { # The original conversion that was inserted or updated and whether there were any errors.
+ "conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
+ "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
+ "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
+ "kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
+ "childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
+ "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
+ "customVariables": [ # Custom floodlight variables.
+ { # A custom floodlight variable.
+ "kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
+ "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
+ "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
+ },
+ ],
+ "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
+ "value": 3.14, # The value of the conversion.
+ "limitAdTracking": True or False, # Whether the user has Limit Ad Tracking set.
+ "quantity": "A String", # The quantity of the conversion.
+ "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
+ "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
+ },
+ "errors": [ # A list of errors related to this conversion.
+ { # The error code and description for a conversion that failed to insert or update.
+ "kind": "dfareporting#conversionError", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
+ "code": "A String", # The error code.
+ "message": "A String", # A description of the error.
+ },
+ ],
+ "kind": "dfareporting#conversionStatus", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
+ },
+ ],
+ "hasFailures": True or False, # Indicates that some or all conversions failed to insert.
+ "kind": "dfareporting#conversionsBatchInsertResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse".
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.countries.html b/docs/dyn/dfareporting_v2_5beta1.countries.html
similarity index 95%
rename from docs/dyn/dfareporting_v2_1.countries.html
rename to docs/dyn/dfareporting_v2_5beta1.countries.html
index 3b354df..ec8f7d2 100644
--- a/docs/dyn/dfareporting_v2_1.countries.html
+++ b/docs/dyn/dfareporting_v2_5beta1.countries.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.countries.html">countries</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.countries.html">countries</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, dartId)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_0.creativeAssets.html b/docs/dyn/dfareporting_v2_5beta1.creativeAssets.html
similarity index 90%
rename from docs/dyn/dfareporting_v2_0.creativeAssets.html
rename to docs/dyn/dfareporting_v2_5beta1.creativeAssets.html
index 7194e10..5f7bfd1 100644
--- a/docs/dyn/dfareporting_v2_0.creativeAssets.html
+++ b/docs/dyn/dfareporting_v2_5beta1.creativeAssets.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.creativeAssets.html">creativeAssets</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.creativeAssets.html">creativeAssets</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#insert">insert(profileId, advertiserId, body=None, media_body=None)</a></code></p>
@@ -92,32 +92,35 @@
"warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
#
# Possible values are:
- # - "CLICK_TAG_NON_TOP_LEVEL"
+ # - "ADMOB_REFERENCED"
+ # - "ASSET_FORMAT_UNSUPPORTED_DCM"
+ # - "ASSET_INVALID"
+ # - "CLICK_TAG_HARD_CODED"
+ # - "CLICK_TAG_INVALID"
+ # - "CLICK_TAG_IN_GWD"
# - "CLICK_TAG_MISSING"
# - "CLICK_TAG_MORE_THAN_ONE"
- # - "CLICK_TAG_INVALID"
- # - "ORPHANED_ASSET"
- # - "PRIMARY_HTML_MISSING"
+ # - "CLICK_TAG_NON_TOP_LEVEL"
+ # - "COMPONENT_UNSUPPORTED_DCM"
+ # - "ENABLER_UNSUPPORTED_METHOD_DCM"
# - "EXTERNAL_FILE_REFERENCED"
- # - "MRAID_REFERENCED"
- # - "ADMOB_REFERENCED"
+ # - "FILE_DETAIL_EMPTY"
# - "FILE_TYPE_INVALID"
- # - "ZIP_INVALID"
+ # - "GWD_PROPERTIES_INVALID"
+ # - "HTML5_FEATURE_UNSUPPORTED"
# - "LINKED_FILE_NOT_FOUND"
# - "MAX_FLASH_VERSION_11"
+ # - "MRAID_REFERENCED"
# - "NOT_SSL_COMPLIANT"
- # - "FILE_DETAIL_EMPTY"
- # - "ASSET_INVALID"
- # - "GWD_PROPERTIES_INVALID"
- # - "ENABLER_UNSUPPORTED_METHOD_DCM"
- # - "ASSET_FORMAT_UNSUPPORTED_DCM"
- # - "COMPONENT_UNSUPPORTED_DCM"
- # - "HTML5_FEATURE_UNSUPPORTED' "
+ # - "ORPHANED_ASSET"
+ # - "PRIMARY_HTML_MISSING"
+ # - "SVG_INVALID"
+ # - "ZIP_INVALID"
"A String",
],
"clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
@@ -141,32 +144,35 @@
"warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
#
# Possible values are:
- # - "CLICK_TAG_NON_TOP_LEVEL"
+ # - "ADMOB_REFERENCED"
+ # - "ASSET_FORMAT_UNSUPPORTED_DCM"
+ # - "ASSET_INVALID"
+ # - "CLICK_TAG_HARD_CODED"
+ # - "CLICK_TAG_INVALID"
+ # - "CLICK_TAG_IN_GWD"
# - "CLICK_TAG_MISSING"
# - "CLICK_TAG_MORE_THAN_ONE"
- # - "CLICK_TAG_INVALID"
- # - "ORPHANED_ASSET"
- # - "PRIMARY_HTML_MISSING"
+ # - "CLICK_TAG_NON_TOP_LEVEL"
+ # - "COMPONENT_UNSUPPORTED_DCM"
+ # - "ENABLER_UNSUPPORTED_METHOD_DCM"
# - "EXTERNAL_FILE_REFERENCED"
- # - "MRAID_REFERENCED"
- # - "ADMOB_REFERENCED"
+ # - "FILE_DETAIL_EMPTY"
# - "FILE_TYPE_INVALID"
- # - "ZIP_INVALID"
+ # - "GWD_PROPERTIES_INVALID"
+ # - "HTML5_FEATURE_UNSUPPORTED"
# - "LINKED_FILE_NOT_FOUND"
# - "MAX_FLASH_VERSION_11"
+ # - "MRAID_REFERENCED"
# - "NOT_SSL_COMPLIANT"
- # - "FILE_DETAIL_EMPTY"
- # - "ASSET_INVALID"
- # - "GWD_PROPERTIES_INVALID"
- # - "ENABLER_UNSUPPORTED_METHOD_DCM"
- # - "ASSET_FORMAT_UNSUPPORTED_DCM"
- # - "COMPONENT_UNSUPPORTED_DCM"
- # - "HTML5_FEATURE_UNSUPPORTED' "
+ # - "ORPHANED_ASSET"
+ # - "PRIMARY_HTML_MISSING"
+ # - "SVG_INVALID"
+ # - "ZIP_INVALID"
"A String",
],
"clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
diff --git a/docs/dyn/dfareporting_v2_1.creativeFieldValues.html b/docs/dyn/dfareporting_v2_5beta1.creativeFieldValues.html
similarity index 98%
rename from docs/dyn/dfareporting_v2_1.creativeFieldValues.html
rename to docs/dyn/dfareporting_v2_5beta1.creativeFieldValues.html
index 7292408..62bff66 100644
--- a/docs/dyn/dfareporting_v2_1.creativeFieldValues.html
+++ b/docs/dyn/dfareporting_v2_5beta1.creativeFieldValues.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.creativeFieldValues.html">creativeFieldValues</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.creativeFieldValues.html">creativeFieldValues</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(profileId, creativeFieldId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.creativeFields.html b/docs/dyn/dfareporting_v2_5beta1.creativeFields.html
similarity index 98%
rename from docs/dyn/dfareporting_v2_1.creativeFields.html
rename to docs/dyn/dfareporting_v2_5beta1.creativeFields.html
index 3e54352..2d3506a 100644
--- a/docs/dyn/dfareporting_v2_1.creativeFields.html
+++ b/docs/dyn/dfareporting_v2_5beta1.creativeFields.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.creativeFields.html">creativeFields</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.creativeFields.html">creativeFields</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.creativeGroups.html b/docs/dyn/dfareporting_v2_5beta1.creativeGroups.html
similarity index 99%
rename from docs/dyn/dfareporting_v2_1.creativeGroups.html
rename to docs/dyn/dfareporting_v2_5beta1.creativeGroups.html
index 428e284..e902f81 100644
--- a/docs/dyn/dfareporting_v2_1.creativeGroups.html
+++ b/docs/dyn/dfareporting_v2_5beta1.creativeGroups.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.creativeGroups.html">creativeGroups</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.creativeGroups.html">creativeGroups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.creatives.html b/docs/dyn/dfareporting_v2_5beta1.creatives.html
similarity index 87%
rename from docs/dyn/dfareporting_v2_2.creatives.html
rename to docs/dyn/dfareporting_v2_5beta1.creatives.html
index 68289d6..3786294 100644
--- a/docs/dyn/dfareporting_v2_2.creatives.html
+++ b/docs/dyn/dfareporting_v2_5beta1.creatives.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.creatives.html">creatives</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.creatives.html">creatives</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
@@ -105,17 +105,23 @@
An object of the form:
{ # Contains properties of a Creative.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ { # Third-party Tracking URL.
+ "url": "A String", # URL for the specified third-party URL type.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+ },
+ ],
"artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -136,6 +142,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -163,18 +170,13 @@
"studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -195,6 +197,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -203,11 +206,11 @@
},
],
"renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -228,6 +231,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -235,7 +239,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -256,7 +260,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -265,7 +269,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -279,7 +283,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -289,7 +293,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -314,7 +318,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -337,7 +341,7 @@
"backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -358,13 +362,14 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -379,27 +384,27 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
# - "APP_INTERSTITIAL"
# - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
+ # - "DISPLAY"
+ # - "DISPLAY_INTERSTITIAL"
"A String",
],
"adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
@@ -409,27 +414,27 @@
"kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
"subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
"name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
}</pre>
</div>
@@ -443,17 +448,23 @@
The object takes the form of:
{ # Contains properties of a Creative.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ { # Third-party Tracking URL.
+ "url": "A String", # URL for the specified third-party URL type.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+ },
+ ],
"artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -474,6 +485,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -501,18 +513,13 @@
"studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -533,6 +540,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -541,11 +549,11 @@
},
],
"renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -566,6 +574,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -573,7 +582,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -594,7 +603,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -603,7 +612,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -617,7 +626,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -627,7 +636,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -652,7 +661,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -675,7 +684,7 @@
"backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -696,13 +705,14 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -717,27 +727,27 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
# - "APP_INTERSTITIAL"
# - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
+ # - "DISPLAY"
+ # - "DISPLAY_INTERSTITIAL"
"A String",
],
"adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
@@ -747,27 +757,27 @@
"kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
"subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
"name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
}
@@ -775,17 +785,23 @@
An object of the form:
{ # Contains properties of a Creative.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ { # Third-party Tracking URL.
+ "url": "A String", # URL for the specified third-party URL type.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+ },
+ ],
"artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -806,6 +822,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -833,18 +850,13 @@
"studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -865,6 +877,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -873,11 +886,11 @@
},
],
"renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -898,6 +911,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -905,7 +919,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -926,7 +940,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -935,7 +949,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -949,7 +963,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -959,7 +973,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -984,7 +998,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -1007,7 +1021,7 @@
"backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -1028,13 +1042,14 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -1049,27 +1064,27 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
# - "APP_INTERSTITIAL"
# - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
+ # - "DISPLAY"
+ # - "DISPLAY_INTERSTITIAL"
"A String",
],
"adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
@@ -1079,27 +1094,27 @@
"kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
"subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
"name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
}</pre>
</div>
@@ -1133,6 +1148,7 @@
HTML5_BANNER -
IMAGE -
INSTREAM_VIDEO -
+ INSTREAM_VIDEO_REDIRECT -
INTERNAL_REDIRECT -
INTERSTITIAL_INTERNAL_REDIRECT -
REDIRECT -
@@ -1145,7 +1161,6 @@
RICH_MEDIA_MULTI_FLOATING -
RICH_MEDIA_PEEL_DOWN -
TRACKING_TEXT -
- VAST_REDIRECT -
VPAID_LINEAR -
VPAID_NON_LINEAR -
searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
@@ -1165,17 +1180,23 @@
"kind": "dfareporting#creativesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".
"creatives": [ # Creative collection.
{ # Contains properties of a Creative.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ { # Third-party Tracking URL.
+ "url": "A String", # URL for the specified third-party URL type.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+ },
+ ],
"artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -1196,6 +1217,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -1223,18 +1245,13 @@
"studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -1255,6 +1272,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -1263,11 +1281,11 @@
},
],
"renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -1288,6 +1306,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -1295,7 +1314,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -1316,7 +1335,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -1325,7 +1344,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -1339,7 +1358,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -1349,7 +1368,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -1374,7 +1393,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -1397,7 +1416,7 @@
"backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -1418,13 +1437,14 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -1439,27 +1459,27 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
# - "APP_INTERSTITIAL"
# - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
+ # - "DISPLAY"
+ # - "DISPLAY_INTERSTITIAL"
"A String",
],
"adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
@@ -1469,27 +1489,27 @@
"kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
"subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
"name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
},
],
}</pre>
@@ -1520,17 +1540,23 @@
The object takes the form of:
{ # Contains properties of a Creative.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ { # Third-party Tracking URL.
+ "url": "A String", # URL for the specified third-party URL type.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+ },
+ ],
"artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -1551,6 +1577,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -1578,18 +1605,13 @@
"studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -1610,6 +1632,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -1618,11 +1641,11 @@
},
],
"renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -1643,6 +1666,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -1650,7 +1674,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -1671,7 +1695,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -1680,7 +1704,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -1694,7 +1718,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -1704,7 +1728,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -1729,7 +1753,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -1752,7 +1776,7 @@
"backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -1773,13 +1797,14 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -1794,27 +1819,27 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
# - "APP_INTERSTITIAL"
# - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
+ # - "DISPLAY"
+ # - "DISPLAY_INTERSTITIAL"
"A String",
],
"adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
@@ -1824,27 +1849,27 @@
"kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
"subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
"name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
}
@@ -1852,17 +1877,23 @@
An object of the form:
{ # Contains properties of a Creative.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ { # Third-party Tracking URL.
+ "url": "A String", # URL for the specified third-party URL type.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+ },
+ ],
"artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -1883,6 +1914,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -1910,18 +1942,13 @@
"studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -1942,6 +1969,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -1950,11 +1978,11 @@
},
],
"renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -1975,6 +2003,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -1982,7 +2011,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -2003,7 +2032,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -2012,7 +2041,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -2026,7 +2055,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -2036,7 +2065,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -2061,7 +2090,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -2084,7 +2113,7 @@
"backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -2105,13 +2134,14 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -2126,27 +2156,27 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
# - "APP_INTERSTITIAL"
# - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
+ # - "DISPLAY"
+ # - "DISPLAY_INTERSTITIAL"
"A String",
],
"adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
@@ -2156,27 +2186,27 @@
"kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
"subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
"name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
}</pre>
</div>
@@ -2190,17 +2220,23 @@
The object takes the form of:
{ # Contains properties of a Creative.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ { # Third-party Tracking URL.
+ "url": "A String", # URL for the specified third-party URL type.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+ },
+ ],
"artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -2221,6 +2257,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -2248,18 +2285,13 @@
"studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -2280,6 +2312,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -2288,11 +2321,11 @@
},
],
"renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -2313,6 +2346,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -2320,7 +2354,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -2341,7 +2375,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -2350,7 +2384,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -2364,7 +2398,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -2374,7 +2408,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -2399,7 +2433,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -2422,7 +2456,7 @@
"backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -2443,13 +2477,14 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -2464,27 +2499,27 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
# - "APP_INTERSTITIAL"
# - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
+ # - "DISPLAY"
+ # - "DISPLAY_INTERSTITIAL"
"A String",
],
"adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
@@ -2494,27 +2529,27 @@
"kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
"subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
"name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
}
@@ -2522,17 +2557,23 @@
An object of the form:
{ # Contains properties of a Creative.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ { # Third-party Tracking URL.
+ "url": "A String", # URL for the specified third-party URL type.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+ },
+ ],
"artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
"requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
- "timerCustomEvents": [ # List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "timerCustomEvents": [ # List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -2553,6 +2594,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -2580,18 +2622,13 @@
"studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"archived": True or False, # Whether the creative is archived. Applicable to all creative types.
"overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
- "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
- { # Third-party Tracking URL.
- "url": "A String", # URL for the specified third-party URL type.
- "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
- },
- ],
- "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
- "exitCustomEvents": [ # List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -2612,6 +2649,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -2620,11 +2658,11 @@
},
],
"renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
- "counterCustomEvents": [ # List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
{ # Creative Custom Event.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -2645,6 +2683,7 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
@@ -2652,7 +2691,7 @@
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
],
- "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
"creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
{ # Creative Field Assignment.
@@ -2673,7 +2712,7 @@
"id": "A String", # The ID associated with the value if available.
},
"htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -2682,7 +2721,7 @@
},
"type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
"totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
- "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
"studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
{ # Creative Asset.
@@ -2696,7 +2735,7 @@
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size.
},
- "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
"detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
@@ -2706,7 +2745,7 @@
"positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
"id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
- "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"width": 42, # Width of this size.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
@@ -2731,7 +2770,7 @@
# OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
# PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
# TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
- # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM.
+ # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.
# For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.
"zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
@@ -2754,7 +2793,7 @@
"backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
"targetType": "A String", # Target type used by the event.
"artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
- "videoReportingId": "A String", # Reporting ID, used to differentiate multiple videos in a single creative.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
"popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
"showStatusBar": True or False, # Whether to display the browser status bar.
"showScrollBar": True or False, # Whether to display the browser scroll bar.
@@ -2775,13 +2814,14 @@
"height": 42, # Height of this size.
},
},
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
"artworkLabel": "A String", # Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.
"advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
"exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
"id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
"advertiserCustomEventName": "A String", # User-entered name for the event.
},
- "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
"assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
"type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
@@ -2796,27 +2836,27 @@
"customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
},
],
- "redirectUrl": "A String", # URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
"videoDuration": 3.14, # Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
"htmlCodeLocked": True or False, # Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
- "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.
- "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "clickTags": [ # Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
{ # Creative Click Tag.
- "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE
"name": "A String", # Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
"value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
},
],
- "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"active": True or False, # Whether the creative is active. Applicable to all creative types.
- "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types.
#
# Acceptable values are:
# - "APP"
# - "APP_INTERSTITIAL"
# - "IN_STREAM_VIDEO"
- # - "WEB"
- # - "WEB_INTERSTITIAL"
+ # - "DISPLAY"
+ # - "DISPLAY_INTERSTITIAL"
"A String",
],
"adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
@@ -2826,27 +2866,27 @@
"kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
"subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
"name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
- "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
"lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
- "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
"studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
"authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
"allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
- "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
"A String",
],
"auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
- "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE.
"A String",
],
- "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
"customHtml": "A String", # User-entered value.
"targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
},
- "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
}</pre>
</div>
diff --git a/docs/dyn/dfareporting_v2_2.dimensionValues.html b/docs/dyn/dfareporting_v2_5beta1.dimensionValues.html
similarity index 96%
rename from docs/dyn/dfareporting_v2_2.dimensionValues.html
rename to docs/dyn/dfareporting_v2_5beta1.dimensionValues.html
index 9c4c1a0..40c942b 100644
--- a/docs/dyn/dfareporting_v2_2.dimensionValues.html
+++ b/docs/dyn/dfareporting_v2_5beta1.dimensionValues.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.dimensionValues.html">dimensionValues</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.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>
diff --git a/docs/dyn/dfareporting_v2_2.directorySiteContacts.html b/docs/dyn/dfareporting_v2_5beta1.directorySiteContacts.html
similarity index 96%
rename from docs/dyn/dfareporting_v2_2.directorySiteContacts.html
rename to docs/dyn/dfareporting_v2_5beta1.directorySiteContacts.html
index b0a52e9..3b538b5 100644
--- a/docs/dyn/dfareporting_v2_2.directorySiteContacts.html
+++ b/docs/dyn/dfareporting_v2_5beta1.directorySiteContacts.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.directorySiteContacts.html">directorySiteContacts</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.directorySiteContacts.html">directorySiteContacts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.directorySites.html b/docs/dyn/dfareporting_v2_5beta1.directorySites.html
similarity index 94%
rename from docs/dyn/dfareporting_v2_2.directorySites.html
rename to docs/dyn/dfareporting_v2_5beta1.directorySites.html
index 5ce02ee..cade187 100644
--- a/docs/dyn/dfareporting_v2_2.directorySites.html
+++ b/docs/dyn/dfareporting_v2_5beta1.directorySites.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.directorySites.html">directorySites</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.directorySites.html">directorySites</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
@@ -155,6 +155,17 @@
# - "34" for VEF
# - "35" for COP
# - "36" for GTQ
+ # - "37" for PLN
+ # - "39" for INR
+ # - "40" for THB
+ # - "41" for IDR
+ # - "42" for CZK
+ # - "43" for RON
+ # - "44" for HUF
+ # - "45" for RUB
+ # - "46" for AED
+ # - "47" for BGN
+ # - "48" for HRK
"inpageTagFormats": [ # Tag types for regular placements.
#
# Acceptable values are:
@@ -260,6 +271,17 @@
# - "34" for VEF
# - "35" for COP
# - "36" for GTQ
+ # - "37" for PLN
+ # - "39" for INR
+ # - "40" for THB
+ # - "41" for IDR
+ # - "42" for CZK
+ # - "43" for RON
+ # - "44" for HUF
+ # - "45" for RUB
+ # - "46" for AED
+ # - "47" for BGN
+ # - "48" for HRK
"inpageTagFormats": [ # Tag types for regular placements.
#
# Acceptable values are:
@@ -359,6 +381,17 @@
# - "34" for VEF
# - "35" for COP
# - "36" for GTQ
+ # - "37" for PLN
+ # - "39" for INR
+ # - "40" for THB
+ # - "41" for IDR
+ # - "42" for CZK
+ # - "43" for RON
+ # - "44" for HUF
+ # - "45" for RUB
+ # - "46" for AED
+ # - "47" for BGN
+ # - "48" for HRK
"inpageTagFormats": [ # Tag types for regular placements.
#
# Acceptable values are:
@@ -488,6 +521,17 @@
# - "34" for VEF
# - "35" for COP
# - "36" for GTQ
+ # - "37" for PLN
+ # - "39" for INR
+ # - "40" for THB
+ # - "41" for IDR
+ # - "42" for CZK
+ # - "43" for RON
+ # - "44" for HUF
+ # - "45" for RUB
+ # - "46" for AED
+ # - "47" for BGN
+ # - "48" for HRK
"inpageTagFormats": [ # Tag types for regular placements.
#
# Acceptable values are:
diff --git a/docs/dyn/dfareporting_v2_5beta1.dynamicTargetingKeys.html b/docs/dyn/dfareporting_v2_5beta1.dynamicTargetingKeys.html
new file mode 100644
index 0000000..95916f8
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_5beta1.dynamicTargetingKeys.html
@@ -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="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.dynamicTargetingKeys.html">dynamicTargetingKeys</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(profileId, objectId, name, objectType)</a></code></p>
+<p class="firstline">Deletes an existing dynamic targeting key.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(profileId, body)</a></code></p>
+<p class="firstline">Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.</p>
+<p class="toc_element">
+ <code><a href="#list">list(profileId, advertiserId=None, objectId=None, names=None, objectType=None)</a></code></p>
+<p class="firstline">Retrieves a list of dynamic targeting keys.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(profileId, objectId, name, objectType)</code>
+ <pre>Deletes an existing dynamic targeting key.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ objectId: string, ID of the object of this dynamic targeting key. This is a required field. (required)
+ name: string, Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. (required)
+ objectType: string, Type of the object of this dynamic targeting key. This is a required field. (required)
+ Allowed values
+ OBJECT_AD -
+ OBJECT_ADVERTISER -
+ OBJECT_CREATIVE -
+ OBJECT_PLACEMENT -
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(profileId, body)</code>
+ <pre>Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
+ "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
+ "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
+ "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
+ "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
+ "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
+ "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
+ "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
+ "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(profileId, advertiserId=None, objectId=None, names=None, objectType=None)</code>
+ <pre>Retrieves a list of dynamic targeting keys.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserId: string, Select only dynamic targeting keys whose object has this advertiser ID.
+ objectId: string, Select only dynamic targeting keys with this object ID.
+ names: string, Select only dynamic targeting keys exactly matching these names. (repeated)
+ objectType: string, Select only dynamic targeting keys with this object type.
+ Allowed values
+ OBJECT_AD -
+ OBJECT_ADVERTISER -
+ OBJECT_CREATIVE -
+ OBJECT_PLACEMENT -
+
+Returns:
+ An object of the form:
+
+ { # Dynamic Targeting Key List Response
+ "kind": "dfareporting#dynamicTargetingKeysListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse".
+ "dynamicTargetingKeys": [ # Dynamic targeting key collection.
+ { # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
+ "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
+ "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
+ "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
+ "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_2.eventTags.html b/docs/dyn/dfareporting_v2_5beta1.eventTags.html
similarity index 99%
rename from docs/dyn/dfareporting_v2_2.eventTags.html
rename to docs/dyn/dfareporting_v2_5beta1.eventTags.html
index 755ddcf..d893913 100644
--- a/docs/dyn/dfareporting_v2_2.eventTags.html
+++ b/docs/dyn/dfareporting_v2_5beta1.eventTags.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.eventTags.html">eventTags</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.eventTags.html">eventTags</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_0.files.html b/docs/dyn/dfareporting_v2_5beta1.files.html
similarity index 97%
rename from docs/dyn/dfareporting_v2_0.files.html
rename to docs/dyn/dfareporting_v2_5beta1.files.html
index ac497c1..ee6d754 100644
--- a/docs/dyn/dfareporting_v2_0.files.html
+++ b/docs/dyn/dfareporting_v2_5beta1.files.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.files.html">files</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.files.html">files</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(reportId, fileId)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_0.floodlightActivities.html b/docs/dyn/dfareporting_v2_5beta1.floodlightActivities.html
similarity index 99%
rename from docs/dyn/dfareporting_v2_0.floodlightActivities.html
rename to docs/dyn/dfareporting_v2_5beta1.floodlightActivities.html
index 180726e..b402799 100644
--- a/docs/dyn/dfareporting_v2_0.floodlightActivities.html
+++ b/docs/dyn/dfareporting_v2_5beta1.floodlightActivities.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.floodlightActivities.html">floodlightActivities</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.floodlightActivities.html">floodlightActivities</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(profileId, id)</a></code></p>
@@ -472,7 +472,7 @@
ASCENDING -
DESCENDING -
maxResults: integer, Maximum number of results to return.
- searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015" or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015" or simply "floodlightactivity".
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
sortField: string, Field by which to sort the list.
Allowed values
ID -
@@ -490,7 +490,7 @@
{ # Floodlight Activity List Response
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"kind": "dfareporting#floodlightActivitiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".
- "floodlightActivities": [ # Floodlight activity collection
+ "floodlightActivities": [ # Floodlight activity collection.
{ # Contains properties of a Floodlight activity.
"tagString": "A String", # Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
"secure": True or False, # Whether this tag should use SSL.
diff --git a/docs/dyn/dfareporting_v2_2.floodlightActivityGroups.html b/docs/dyn/dfareporting_v2_5beta1.floodlightActivityGroups.html
similarity index 98%
rename from docs/dyn/dfareporting_v2_2.floodlightActivityGroups.html
rename to docs/dyn/dfareporting_v2_5beta1.floodlightActivityGroups.html
index 5b50601..0513a9f 100644
--- a/docs/dyn/dfareporting_v2_2.floodlightActivityGroups.html
+++ b/docs/dyn/dfareporting_v2_5beta1.floodlightActivityGroups.html
@@ -72,12 +72,9 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.floodlightActivityGroups.html">floodlightActivityGroups</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.floodlightActivityGroups.html">floodlightActivityGroups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(profileId, id)</a></code></p>
-<p class="firstline">Deletes an existing floodlight activity group.</p>
-<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
<p class="firstline">Gets one floodlight activity group by ID.</p>
<p class="toc_element">
@@ -97,16 +94,6 @@
<p class="firstline">Updates an existing floodlight activity group.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(profileId, id)</code>
- <pre>Deletes an existing floodlight activity group.
-
-Args:
- profileId: string, User profile ID associated with this request. (required)
- id: string, Floodlight activity Group ID. (required)
-</pre>
-</div>
-
-<div class="method">
<code class="details" id="get">get(profileId, id)</code>
<pre>Gets one floodlight activity group by ID.
diff --git a/docs/dyn/dfareporting_v2_2.floodlightConfigurations.html b/docs/dyn/dfareporting_v2_5beta1.floodlightConfigurations.html
similarity index 97%
rename from docs/dyn/dfareporting_v2_2.floodlightConfigurations.html
rename to docs/dyn/dfareporting_v2_5beta1.floodlightConfigurations.html
index b865916..343e8f8 100644
--- a/docs/dyn/dfareporting_v2_2.floodlightConfigurations.html
+++ b/docs/dyn/dfareporting_v2_5beta1.floodlightConfigurations.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.floodlightConfigurations.html">floodlightConfigurations</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.floodlightConfigurations.html">floodlightConfigurations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
@@ -102,13 +102,6 @@
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
"exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
@@ -156,7 +149,13 @@
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
+ "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+ { # User Defined Variable configuration.
+ "dataType": "A String", # Data type for the variable. This is a required field.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
+ "variableType": "A String", # Variable name in the tag. This is a required field.
+ },
+ ],
"accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
}</pre>
</div>
@@ -178,13 +177,6 @@
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
"exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
@@ -232,7 +224,13 @@
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
+ "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+ { # User Defined Variable configuration.
+ "dataType": "A String", # Data type for the variable. This is a required field.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
+ "variableType": "A String", # Variable name in the tag. This is a required field.
+ },
+ ],
"accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
},
],
@@ -254,13 +252,6 @@
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
"exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
@@ -308,7 +299,13 @@
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
+ "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+ { # User Defined Variable configuration.
+ "dataType": "A String", # Data type for the variable. This is a required field.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
+ "variableType": "A String", # Variable name in the tag. This is a required field.
+ },
+ ],
"accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
}
@@ -320,13 +317,6 @@
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
"exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
@@ -374,7 +364,13 @@
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
+ "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+ { # User Defined Variable configuration.
+ "dataType": "A String", # Data type for the variable. This is a required field.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
+ "variableType": "A String", # Variable name in the tag. This is a required field.
+ },
+ ],
"accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
}</pre>
</div>
@@ -392,13 +388,6 @@
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
"exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
@@ -446,7 +435,13 @@
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
+ "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+ { # User Defined Variable configuration.
+ "dataType": "A String", # Data type for the variable. This is a required field.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
+ "variableType": "A String", # Variable name in the tag. This is a required field.
+ },
+ ],
"accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
}
@@ -458,13 +453,6 @@
"naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
"kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
"exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
- "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
- { # User Defined Variable configuration.
- "dataType": "A String", # Data type for the variable. This is a required field.
- "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
- "variableType": "A String", # Variable name in the tag. This is a required field.
- },
- ],
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.
@@ -512,7 +500,13 @@
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
- "sslRequired": True or False, # Whether floodlight activities owned by this configuration are required to be SSL-compliant.
+ "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+ { # User Defined Variable configuration.
+ "dataType": "A String", # Data type for the variable. This is a required field.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
+ "variableType": "A String", # Variable name in the tag. This is a required field.
+ },
+ ],
"accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
}</pre>
</div>
diff --git a/docs/dyn/dfareporting_v2_5beta1.html b/docs/dyn/dfareporting_v2_5beta1.html
new file mode 100644
index 0000000..b44df52
--- /dev/null
+++ b/docs/dyn/dfareporting_v2_5beta1.html
@@ -0,0 +1,383 @@
+<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_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.accountActiveAdSummaries.html">accountActiveAdSummaries()</a></code>
+</p>
+<p class="firstline">Returns the accountActiveAdSummaries Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.accountPermissionGroups.html">accountPermissionGroups()</a></code>
+</p>
+<p class="firstline">Returns the accountPermissionGroups Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.accountPermissions.html">accountPermissions()</a></code>
+</p>
+<p class="firstline">Returns the accountPermissions Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.accountUserProfiles.html">accountUserProfiles()</a></code>
+</p>
+<p class="firstline">Returns the accountUserProfiles Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.accounts.html">accounts()</a></code>
+</p>
+<p class="firstline">Returns the accounts Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.ads.html">ads()</a></code>
+</p>
+<p class="firstline">Returns the ads Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.advertiserGroups.html">advertiserGroups()</a></code>
+</p>
+<p class="firstline">Returns the advertiserGroups Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.advertisers.html">advertisers()</a></code>
+</p>
+<p class="firstline">Returns the advertisers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.browsers.html">browsers()</a></code>
+</p>
+<p class="firstline">Returns the browsers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.campaignCreativeAssociations.html">campaignCreativeAssociations()</a></code>
+</p>
+<p class="firstline">Returns the campaignCreativeAssociations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.campaigns.html">campaigns()</a></code>
+</p>
+<p class="firstline">Returns the campaigns Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.changeLogs.html">changeLogs()</a></code>
+</p>
+<p class="firstline">Returns the changeLogs Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.cities.html">cities()</a></code>
+</p>
+<p class="firstline">Returns the cities Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.connectionTypes.html">connectionTypes()</a></code>
+</p>
+<p class="firstline">Returns the connectionTypes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.contentCategories.html">contentCategories()</a></code>
+</p>
+<p class="firstline">Returns the contentCategories Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.conversions.html">conversions()</a></code>
+</p>
+<p class="firstline">Returns the conversions Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.countries.html">countries()</a></code>
+</p>
+<p class="firstline">Returns the countries Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.creativeAssets.html">creativeAssets()</a></code>
+</p>
+<p class="firstline">Returns the creativeAssets Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.creativeFieldValues.html">creativeFieldValues()</a></code>
+</p>
+<p class="firstline">Returns the creativeFieldValues Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.creativeFields.html">creativeFields()</a></code>
+</p>
+<p class="firstline">Returns the creativeFields Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.creativeGroups.html">creativeGroups()</a></code>
+</p>
+<p class="firstline">Returns the creativeGroups Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.creatives.html">creatives()</a></code>
+</p>
+<p class="firstline">Returns the creatives Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.dimensionValues.html">dimensionValues()</a></code>
+</p>
+<p class="firstline">Returns the dimensionValues Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.directorySiteContacts.html">directorySiteContacts()</a></code>
+</p>
+<p class="firstline">Returns the directorySiteContacts Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.directorySites.html">directorySites()</a></code>
+</p>
+<p class="firstline">Returns the directorySites Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.dynamicTargetingKeys.html">dynamicTargetingKeys()</a></code>
+</p>
+<p class="firstline">Returns the dynamicTargetingKeys Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.eventTags.html">eventTags()</a></code>
+</p>
+<p class="firstline">Returns the eventTags Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.files.html">files()</a></code>
+</p>
+<p class="firstline">Returns the files Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.floodlightActivities.html">floodlightActivities()</a></code>
+</p>
+<p class="firstline">Returns the floodlightActivities Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.floodlightActivityGroups.html">floodlightActivityGroups()</a></code>
+</p>
+<p class="firstline">Returns the floodlightActivityGroups Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.floodlightConfigurations.html">floodlightConfigurations()</a></code>
+</p>
+<p class="firstline">Returns the floodlightConfigurations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.inventoryItems.html">inventoryItems()</a></code>
+</p>
+<p class="firstline">Returns the inventoryItems Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.landingPages.html">landingPages()</a></code>
+</p>
+<p class="firstline">Returns the landingPages Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.metros.html">metros()</a></code>
+</p>
+<p class="firstline">Returns the metros Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.mobileCarriers.html">mobileCarriers()</a></code>
+</p>
+<p class="firstline">Returns the mobileCarriers Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.operatingSystemVersions.html">operatingSystemVersions()</a></code>
+</p>
+<p class="firstline">Returns the operatingSystemVersions Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.operatingSystems.html">operatingSystems()</a></code>
+</p>
+<p class="firstline">Returns the operatingSystems Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.orderDocuments.html">orderDocuments()</a></code>
+</p>
+<p class="firstline">Returns the orderDocuments Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.orders.html">orders()</a></code>
+</p>
+<p class="firstline">Returns the orders Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.placementGroups.html">placementGroups()</a></code>
+</p>
+<p class="firstline">Returns the placementGroups Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.placementStrategies.html">placementStrategies()</a></code>
+</p>
+<p class="firstline">Returns the placementStrategies Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.placements.html">placements()</a></code>
+</p>
+<p class="firstline">Returns the placements Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.platformTypes.html">platformTypes()</a></code>
+</p>
+<p class="firstline">Returns the platformTypes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.postalCodes.html">postalCodes()</a></code>
+</p>
+<p class="firstline">Returns the postalCodes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.projects.html">projects()</a></code>
+</p>
+<p class="firstline">Returns the projects Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.regions.html">regions()</a></code>
+</p>
+<p class="firstline">Returns the regions Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.remarketingListShares.html">remarketingListShares()</a></code>
+</p>
+<p class="firstline">Returns the remarketingListShares Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.remarketingLists.html">remarketingLists()</a></code>
+</p>
+<p class="firstline">Returns the remarketingLists Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.reports.html">reports()</a></code>
+</p>
+<p class="firstline">Returns the reports Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.sites.html">sites()</a></code>
+</p>
+<p class="firstline">Returns the sites Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.sizes.html">sizes()</a></code>
+</p>
+<p class="firstline">Returns the sizes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.subaccounts.html">subaccounts()</a></code>
+</p>
+<p class="firstline">Returns the subaccounts Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.targetableRemarketingLists.html">targetableRemarketingLists()</a></code>
+</p>
+<p class="firstline">Returns the targetableRemarketingLists Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.userProfiles.html">userProfiles()</a></code>
+</p>
+<p class="firstline">Returns the userProfiles Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.userRolePermissionGroups.html">userRolePermissionGroups()</a></code>
+</p>
+<p class="firstline">Returns the userRolePermissionGroups Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.userRolePermissions.html">userRolePermissions()</a></code>
+</p>
+<p class="firstline">Returns the userRolePermissions Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dfareporting_v2_5beta1.userRoles.html">userRoles()</a></code>
+</p>
+<p class="firstline">Returns the userRoles Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v2_1.inventoryItems.html b/docs/dyn/dfareporting_v2_5beta1.inventoryItems.html
similarity index 88%
rename from docs/dyn/dfareporting_v2_1.inventoryItems.html
rename to docs/dyn/dfareporting_v2_5beta1.inventoryItems.html
index f6e988c..c16a194 100644
--- a/docs/dyn/dfareporting_v2_1.inventoryItems.html
+++ b/docs/dyn/dfareporting_v2_5beta1.inventoryItems.html
@@ -72,13 +72,13 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.inventoryItems.html">inventoryItems</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.inventoryItems.html">inventoryItems</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, projectId, id)</a></code></p>
<p class="firstline">Gets one inventory item by ID.</p>
<p class="toc_element">
- <code><a href="#list">list(profileId, projectId, orderId=None, pageToken=None, sortField=None, ids=None, maxResults=None, inPlan=None, siteId=None, sortOrder=None)</a></code></p>
+ <code><a href="#list">list(profileId, projectId, pageToken=None, inPlan=None, sortOrder=None, type=None, orderId=None, maxResults=None, siteId=None, sortField=None, ids=None)</a></code></p>
<p class="firstline">Retrieves a list of inventory items, possibly filtered.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -135,11 +135,12 @@
"height": "A String", # Height of this ad slot.
"width": "A String", # Width of this ad slot.
"paymentSourceType": "A String", # Payment source type of this ad slot.
- "compatibility": "A String", # Ad slot compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
},
],
"projectId": "A String", # Project ID of this inventory item.
"rfpId": "A String", # RFP ID of this inventory item.
+ "type": "A String", # Type of inventory item.
"contentCategoryId": "A String", # Content category ID of this inventory item.
"placementStrategyId": "A String", # Placement strategy ID of this inventory item.
"accountId": "A String", # Account ID of this inventory item.
@@ -147,26 +148,30 @@
</div>
<div class="method">
- <code class="details" id="list">list(profileId, projectId, orderId=None, pageToken=None, sortField=None, ids=None, maxResults=None, inPlan=None, siteId=None, sortOrder=None)</code>
+ <code class="details" id="list">list(profileId, projectId, pageToken=None, inPlan=None, sortOrder=None, type=None, orderId=None, maxResults=None, siteId=None, sortField=None, ids=None)</code>
<pre>Retrieves a list of inventory items, possibly filtered.
Args:
profileId: string, User profile ID associated with this request. (required)
projectId: string, Project ID for order documents. (required)
- orderId: string, Select only inventory items that belong to specified orders. (repeated)
pageToken: string, Value of the nextPageToken from the previous result page.
+ inPlan: boolean, Select only inventory items that are in plan.
+ sortOrder: string, Order of sorted results, default is ASCENDING.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ type: string, Select only inventory items with this type.
+ Allowed values
+ PLANNING_PLACEMENT_TYPE_CREDIT -
+ PLANNING_PLACEMENT_TYPE_REGULAR -
+ orderId: string, Select only inventory items that belong to specified orders. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ siteId: string, Select only inventory items that are associated with these sites. (repeated)
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
ids: string, Select only inventory items with these IDs. (repeated)
- maxResults: integer, Maximum number of results to return.
- inPlan: boolean, Select only inventory items that are in plan.
- siteId: string, Select only inventory items that are associated with these sites. (repeated)
- sortOrder: string, Order of sorted results, default is ASCENDING.
- Allowed values
- ASCENDING -
- DESCENDING -
Returns:
An object of the form:
@@ -214,11 +219,12 @@
"height": "A String", # Height of this ad slot.
"width": "A String", # Width of this ad slot.
"paymentSourceType": "A String", # Payment source type of this ad slot.
- "compatibility": "A String", # Ad slot compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
+ "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
},
],
"projectId": "A String", # Project ID of this inventory item.
"rfpId": "A String", # RFP ID of this inventory item.
+ "type": "A String", # Type of inventory item.
"contentCategoryId": "A String", # Content category ID of this inventory item.
"placementStrategyId": "A String", # Placement strategy ID of this inventory item.
"accountId": "A String", # Account ID of this inventory item.
diff --git a/docs/dyn/dfareporting_v2_1.landingPages.html b/docs/dyn/dfareporting_v2_5beta1.landingPages.html
similarity index 98%
rename from docs/dyn/dfareporting_v2_1.landingPages.html
rename to docs/dyn/dfareporting_v2_5beta1.landingPages.html
index 63c9f58..f6fab0c 100644
--- a/docs/dyn/dfareporting_v2_1.landingPages.html
+++ b/docs/dyn/dfareporting_v2_5beta1.landingPages.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.landingPages.html">landingPages</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.landingPages.html">landingPages</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(profileId, campaignId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.metros.html b/docs/dyn/dfareporting_v2_5beta1.metros.html
similarity index 93%
rename from docs/dyn/dfareporting_v2_1.metros.html
rename to docs/dyn/dfareporting_v2_5beta1.metros.html
index ede4677..dad0971 100644
--- a/docs/dyn/dfareporting_v2_1.metros.html
+++ b/docs/dyn/dfareporting_v2_5beta1.metros.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.metros.html">metros</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.metros.html">metros</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(profileId)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.mobileCarriers.html b/docs/dyn/dfareporting_v2_5beta1.mobileCarriers.html
similarity index 94%
rename from docs/dyn/dfareporting_v2_1.mobileCarriers.html
rename to docs/dyn/dfareporting_v2_5beta1.mobileCarriers.html
index 7bfa5f0..28de22f 100644
--- a/docs/dyn/dfareporting_v2_1.mobileCarriers.html
+++ b/docs/dyn/dfareporting_v2_5beta1.mobileCarriers.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.mobileCarriers.html">mobileCarriers</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.mobileCarriers.html">mobileCarriers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.operatingSystemVersions.html b/docs/dyn/dfareporting_v2_5beta1.operatingSystemVersions.html
similarity index 96%
rename from docs/dyn/dfareporting_v2_2.operatingSystemVersions.html
rename to docs/dyn/dfareporting_v2_5beta1.operatingSystemVersions.html
index 4bfc68c..ae4c904 100644
--- a/docs/dyn/dfareporting_v2_2.operatingSystemVersions.html
+++ b/docs/dyn/dfareporting_v2_5beta1.operatingSystemVersions.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.operatingSystemVersions.html">operatingSystemVersions</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.operatingSystemVersions.html">operatingSystemVersions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.operatingSystems.html b/docs/dyn/dfareporting_v2_5beta1.operatingSystems.html
similarity index 94%
rename from docs/dyn/dfareporting_v2_1.operatingSystems.html
rename to docs/dyn/dfareporting_v2_5beta1.operatingSystems.html
index d29eb2a..3df5c7f 100644
--- a/docs/dyn/dfareporting_v2_1.operatingSystems.html
+++ b/docs/dyn/dfareporting_v2_5beta1.operatingSystems.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.operatingSystems.html">operatingSystems</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.operatingSystems.html">operatingSystems</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, dartId)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.orderDocuments.html b/docs/dyn/dfareporting_v2_5beta1.orderDocuments.html
similarity index 97%
rename from docs/dyn/dfareporting_v2_2.orderDocuments.html
rename to docs/dyn/dfareporting_v2_5beta1.orderDocuments.html
index 252f323..9813a90 100644
--- a/docs/dyn/dfareporting_v2_2.orderDocuments.html
+++ b/docs/dyn/dfareporting_v2_5beta1.orderDocuments.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.orderDocuments.html">orderDocuments</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.orderDocuments.html">orderDocuments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, projectId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.orders.html b/docs/dyn/dfareporting_v2_5beta1.orders.html
similarity index 98%
rename from docs/dyn/dfareporting_v2_2.orders.html
rename to docs/dyn/dfareporting_v2_5beta1.orders.html
index 7262633..7a3e870 100644
--- a/docs/dyn/dfareporting_v2_2.orders.html
+++ b/docs/dyn/dfareporting_v2_5beta1.orders.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.orders.html">orders</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.orders.html">orders</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, projectId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.placementGroups.html b/docs/dyn/dfareporting_v2_5beta1.placementGroups.html
similarity index 99%
rename from docs/dyn/dfareporting_v2_2.placementGroups.html
rename to docs/dyn/dfareporting_v2_5beta1.placementGroups.html
index d46812c..5ed079d 100644
--- a/docs/dyn/dfareporting_v2_2.placementGroups.html
+++ b/docs/dyn/dfareporting_v2_5beta1.placementGroups.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.placementGroups.html">placementGroups</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.placementGroups.html">placementGroups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
@@ -420,6 +420,7 @@
PRICING_TYPE_CPA -
PRICING_TYPE_CPC -
PRICING_TYPE_CPM -
+ PRICING_TYPE_CPM_ACTIVEVIEW -
PRICING_TYPE_FLAT_RATE_CLICKS -
PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
diff --git a/docs/dyn/dfareporting_v2_1.placementStrategies.html b/docs/dyn/dfareporting_v2_5beta1.placementStrategies.html
similarity index 98%
rename from docs/dyn/dfareporting_v2_1.placementStrategies.html
rename to docs/dyn/dfareporting_v2_5beta1.placementStrategies.html
index c1229b1..6ca59c8 100644
--- a/docs/dyn/dfareporting_v2_1.placementStrategies.html
+++ b/docs/dyn/dfareporting_v2_5beta1.placementStrategies.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.placementStrategies.html">placementStrategies</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.placementStrategies.html">placementStrategies</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.placements.html b/docs/dyn/dfareporting_v2_5beta1.placements.html
similarity index 96%
rename from docs/dyn/dfareporting_v2_2.placements.html
rename to docs/dyn/dfareporting_v2_5beta1.placements.html
index 149cb48..69e7257 100644
--- a/docs/dyn/dfareporting_v2_2.placements.html
+++ b/docs/dyn/dfareporting_v2_5beta1.placements.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.placements.html">placements</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.placements.html">placements</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#generatetags">generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None)</a></code></p>
@@ -252,7 +252,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -397,7 +397,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -536,7 +536,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -594,6 +594,7 @@
PRICING_TYPE_CPA -
PRICING_TYPE_CPC -
PRICING_TYPE_CPM -
+ PRICING_TYPE_CPM_ACTIVEVIEW -
PRICING_TYPE_FLAT_RATE_CLICKS -
PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
campaignIds: string, Select only placements that belong to these campaigns. (repeated)
@@ -611,13 +612,13 @@
archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
maxResults: integer, Maximum number of results to return.
minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
- compatibilities: string, Select only placements that are associated with these compatibilities. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. (repeated)
+ compatibilities: string, Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. (repeated)
Allowed values
APP -
APP_INTERSTITIAL -
+ DISPLAY -
+ DISPLAY_INTERSTITIAL -
IN_STREAM_VIDEO -
- WEB -
- WEB_INTERSTITIAL -
searchString: string, Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement".
minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated)
@@ -729,7 +730,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -891,7 +892,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -1030,7 +1031,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -1175,7 +1176,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
@@ -1314,7 +1315,7 @@
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and 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.
},
- "compatibility": "A String", # Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
diff --git a/docs/dyn/dfareporting_v2_1.platformTypes.html b/docs/dyn/dfareporting_v2_5beta1.platformTypes.html
similarity index 94%
rename from docs/dyn/dfareporting_v2_1.platformTypes.html
rename to docs/dyn/dfareporting_v2_5beta1.platformTypes.html
index 2969f3b..48b5790 100644
--- a/docs/dyn/dfareporting_v2_1.platformTypes.html
+++ b/docs/dyn/dfareporting_v2_5beta1.platformTypes.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.platformTypes.html">platformTypes</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.platformTypes.html">platformTypes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.postalCodes.html b/docs/dyn/dfareporting_v2_5beta1.postalCodes.html
similarity index 95%
rename from docs/dyn/dfareporting_v2_2.postalCodes.html
rename to docs/dyn/dfareporting_v2_5beta1.postalCodes.html
index ca82e60..175530d 100644
--- a/docs/dyn/dfareporting_v2_2.postalCodes.html
+++ b/docs/dyn/dfareporting_v2_5beta1.postalCodes.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.postalCodes.html">postalCodes</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.postalCodes.html">postalCodes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, code)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.projects.html b/docs/dyn/dfareporting_v2_5beta1.projects.html
similarity index 97%
rename from docs/dyn/dfareporting_v2_1.projects.html
rename to docs/dyn/dfareporting_v2_5beta1.projects.html
index 69fa5dd..889443d 100644
--- a/docs/dyn/dfareporting_v2_1.projects.html
+++ b/docs/dyn/dfareporting_v2_5beta1.projects.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.projects.html">projects</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.regions.html b/docs/dyn/dfareporting_v2_5beta1.regions.html
similarity index 93%
rename from docs/dyn/dfareporting_v2_2.regions.html
rename to docs/dyn/dfareporting_v2_5beta1.regions.html
index bcccc01..134ea4b 100644
--- a/docs/dyn/dfareporting_v2_2.regions.html
+++ b/docs/dyn/dfareporting_v2_5beta1.regions.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.regions.html">regions</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.regions.html">regions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(profileId)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.remarketingListShares.html b/docs/dyn/dfareporting_v2_5beta1.remarketingListShares.html
similarity index 97%
rename from docs/dyn/dfareporting_v2_1.remarketingListShares.html
rename to docs/dyn/dfareporting_v2_5beta1.remarketingListShares.html
index 942e5b3..ca59463 100644
--- a/docs/dyn/dfareporting_v2_1.remarketingListShares.html
+++ b/docs/dyn/dfareporting_v2_5beta1.remarketingListShares.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.remarketingListShares.html">remarketingListShares</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.remarketingListShares.html">remarketingListShares</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, remarketingListId)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.remarketingLists.html b/docs/dyn/dfareporting_v2_5beta1.remarketingLists.html
similarity index 99%
rename from docs/dyn/dfareporting_v2_2.remarketingLists.html
rename to docs/dyn/dfareporting_v2_5beta1.remarketingLists.html
index 4da3175..d30d0df 100644
--- a/docs/dyn/dfareporting_v2_2.remarketingLists.html
+++ b/docs/dyn/dfareporting_v2_5beta1.remarketingLists.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.remarketingLists.html">remarketingLists</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.remarketingLists.html">remarketingLists</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.reports.compatibleFields.html b/docs/dyn/dfareporting_v2_5beta1.reports.compatibleFields.html
similarity index 99%
rename from docs/dyn/dfareporting_v2_2.reports.compatibleFields.html
rename to docs/dyn/dfareporting_v2_5beta1.reports.compatibleFields.html
index 740d16e..dbf0b73 100644
--- a/docs/dyn/dfareporting_v2_2.reports.compatibleFields.html
+++ b/docs/dyn/dfareporting_v2_5beta1.reports.compatibleFields.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.reports.html">reports</a> . <a href="dfareporting_v2_2.reports.compatibleFields.html">compatibleFields</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.reports.html">reports</a> . <a href="dfareporting_v2_5beta1.reports.compatibleFields.html">compatibleFields</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#query">query(profileId, body)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_0.reports.files.html b/docs/dyn/dfareporting_v2_5beta1.reports.files.html
similarity index 97%
rename from docs/dyn/dfareporting_v2_0.reports.files.html
rename to docs/dyn/dfareporting_v2_5beta1.reports.files.html
index d5de9f4..8767784 100644
--- a/docs/dyn/dfareporting_v2_0.reports.files.html
+++ b/docs/dyn/dfareporting_v2_5beta1.reports.files.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.reports.html">reports</a> . <a href="dfareporting_v2_0.reports.files.html">files</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.reports.html">reports</a> . <a href="dfareporting_v2_5beta1.reports.files.html">files</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, reportId, fileId)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_0.reports.html b/docs/dyn/dfareporting_v2_5beta1.reports.html
similarity index 99%
rename from docs/dyn/dfareporting_v2_0.reports.html
rename to docs/dyn/dfareporting_v2_5beta1.reports.html
index 58bedcb..835adf5 100644
--- a/docs/dyn/dfareporting_v2_0.reports.html
+++ b/docs/dyn/dfareporting_v2_5beta1.reports.html
@@ -72,15 +72,15 @@
</style>
-<h1><a href="dfareporting_v2_0.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_0.reports.html">reports</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="dfareporting_v2_0.reports.compatibleFields.html">compatibleFields()</a></code>
+ <code><a href="dfareporting_v2_5beta1.reports.compatibleFields.html">compatibleFields()</a></code>
</p>
<p class="firstline">Returns the compatibleFields Resource.</p>
<p class="toc_element">
- <code><a href="dfareporting_v2_0.reports.files.html">files()</a></code>
+ <code><a href="dfareporting_v2_5beta1.reports.files.html">files()</a></code>
</p>
<p class="firstline">Returns the files Resource.</p>
diff --git a/docs/dyn/dfareporting_v2_1.sites.html b/docs/dyn/dfareporting_v2_5beta1.sites.html
similarity index 92%
rename from docs/dyn/dfareporting_v2_1.sites.html
rename to docs/dyn/dfareporting_v2_5beta1.sites.html
index 9559f52..319df31 100644
--- a/docs/dyn/dfareporting_v2_1.sites.html
+++ b/docs/dyn/dfareporting_v2_5beta1.sites.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.sites.html">sites</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.sites.html">sites</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
@@ -134,6 +134,7 @@
"iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
"iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
},
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
@@ -202,6 +203,7 @@
"iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
"iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
},
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
@@ -264,6 +266,7 @@
"iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
"iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
},
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
@@ -327,7 +330,7 @@
{ # Site List Response
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"kind": "dfareporting#sitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
- "sites": [ # Site collection
+ "sites": [ # Site collection.
{ # Contains properties of a site.
"kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
@@ -358,6 +361,7 @@
"iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
"iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
},
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
@@ -443,6 +447,7 @@
"iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
"iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
},
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
@@ -505,6 +510,7 @@
"iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
"iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
},
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
@@ -573,6 +579,7 @@
"iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
"iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
},
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
@@ -635,6 +642,7 @@
"iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
"iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
},
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives on this site. The same setting videoActiveViewOptOut exists on the directory site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
diff --git a/docs/dyn/dfareporting_v2_2.sizes.html b/docs/dyn/dfareporting_v2_5beta1.sizes.html
similarity index 96%
rename from docs/dyn/dfareporting_v2_2.sizes.html
rename to docs/dyn/dfareporting_v2_5beta1.sizes.html
index 5d1dd30..d970e47 100644
--- a/docs/dyn/dfareporting_v2_2.sizes.html
+++ b/docs/dyn/dfareporting_v2_5beta1.sizes.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.sizes.html">sizes</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.sizes.html">sizes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.subaccounts.html b/docs/dyn/dfareporting_v2_5beta1.subaccounts.html
similarity index 98%
rename from docs/dyn/dfareporting_v2_2.subaccounts.html
rename to docs/dyn/dfareporting_v2_5beta1.subaccounts.html
index 3deccbb..ce888d7 100644
--- a/docs/dyn/dfareporting_v2_2.subaccounts.html
+++ b/docs/dyn/dfareporting_v2_5beta1.subaccounts.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.subaccounts.html">subaccounts</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.subaccounts.html">subaccounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_2.targetableRemarketingLists.html b/docs/dyn/dfareporting_v2_5beta1.targetableRemarketingLists.html
similarity index 97%
rename from docs/dyn/dfareporting_v2_2.targetableRemarketingLists.html
rename to docs/dyn/dfareporting_v2_5beta1.targetableRemarketingLists.html
index a9bec55..7a082f6 100644
--- a/docs/dyn/dfareporting_v2_2.targetableRemarketingLists.html
+++ b/docs/dyn/dfareporting_v2_5beta1.targetableRemarketingLists.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_2.targetableRemarketingLists.html">targetableRemarketingLists</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.targetableRemarketingLists.html">targetableRemarketingLists</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.userProfiles.html b/docs/dyn/dfareporting_v2_5beta1.userProfiles.html
similarity index 95%
rename from docs/dyn/dfareporting_v2_1.userProfiles.html
rename to docs/dyn/dfareporting_v2_5beta1.userProfiles.html
index 0e0c800..18de5af 100644
--- a/docs/dyn/dfareporting_v2_1.userProfiles.html
+++ b/docs/dyn/dfareporting_v2_5beta1.userProfiles.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.userProfiles.html">userProfiles</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.userProfiles.html">userProfiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.userRolePermissionGroups.html b/docs/dyn/dfareporting_v2_5beta1.userRolePermissionGroups.html
similarity index 94%
rename from docs/dyn/dfareporting_v2_1.userRolePermissionGroups.html
rename to docs/dyn/dfareporting_v2_5beta1.userRolePermissionGroups.html
index d159bc6..4fac1a1 100644
--- a/docs/dyn/dfareporting_v2_1.userRolePermissionGroups.html
+++ b/docs/dyn/dfareporting_v2_5beta1.userRolePermissionGroups.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.userRolePermissionGroups.html">userRolePermissionGroups</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.userRolePermissionGroups.html">userRolePermissionGroups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.userRolePermissions.html b/docs/dyn/dfareporting_v2_5beta1.userRolePermissions.html
similarity index 94%
rename from docs/dyn/dfareporting_v2_1.userRolePermissions.html
rename to docs/dyn/dfareporting_v2_5beta1.userRolePermissions.html
index e473beb..d60aa63 100644
--- a/docs/dyn/dfareporting_v2_1.userRolePermissions.html
+++ b/docs/dyn/dfareporting_v2_5beta1.userRolePermissions.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.userRolePermissions.html">userRolePermissions</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.userRolePermissions.html">userRolePermissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
diff --git a/docs/dyn/dfareporting_v2_1.userRoles.html b/docs/dyn/dfareporting_v2_5beta1.userRoles.html
similarity index 99%
rename from docs/dyn/dfareporting_v2_1.userRoles.html
rename to docs/dyn/dfareporting_v2_5beta1.userRoles.html
index 06e4a93..7efb586 100644
--- a/docs/dyn/dfareporting_v2_1.userRoles.html
+++ b/docs/dyn/dfareporting_v2_5beta1.userRoles.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dfareporting_v2_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_1.userRoles.html">userRoles</a></h1>
+<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.userRoles.html">userRoles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(profileId, id)</a></code></p>
diff --git a/docs/dyn/dns_v1beta1.html b/docs/dyn/dns_v1beta1.html
deleted file mode 100644
index 1d0e2aa..0000000
--- a/docs/dyn/dns_v1beta1.html
+++ /dev/null
@@ -1,97 +0,0 @@
-<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="dns_v1beta1.html">Google Cloud DNS API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="dns_v1beta1.changes.html">changes()</a></code>
-</p>
-<p class="firstline">Returns the changes Resource.</p>
-
-<p class="toc_element">
- <code><a href="dns_v1beta1.managedZones.html">managedZones()</a></code>
-</p>
-<p class="firstline">Returns the managedZones Resource.</p>
-
-<p class="toc_element">
- <code><a href="dns_v1beta1.projects.html">projects()</a></code>
-</p>
-<p class="firstline">Returns the projects Resource.</p>
-
-<p class="toc_element">
- <code><a href="dns_v1beta1.resourceRecordSets.html">resourceRecordSets()</a></code>
-</p>
-<p class="firstline">Returns the resourceRecordSets Resource.</p>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dns_v1beta1.managedZones.html b/docs/dyn/dns_v1beta1.managedZones.html
deleted file mode 100644
index e82fec8..0000000
--- a/docs/dyn/dns_v1beta1.managedZones.html
+++ /dev/null
@@ -1,216 +0,0 @@
-<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="dns_v1beta1.html">Google Cloud DNS API</a> . <a href="dns_v1beta1.managedZones.html">managedZones</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#create">create(project, body)</a></code></p>
-<p class="firstline">Create a new ManagedZone.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(project, managedZone)</a></code></p>
-<p class="firstline">Delete a previously created ManagedZone.</p>
-<p class="toc_element">
- <code><a href="#get">get(project, managedZone)</a></code></p>
-<p class="firstline">Fetch the representation of an existing ManagedZone.</p>
-<p class="toc_element">
- <code><a href="#list">list(project, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Enumerate ManagedZones that have been created but not yet deleted.</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="create">create(project, body)</code>
- <pre>Create a new ManagedZone.
-
-Args:
- project: string, Identifies the project addressed by this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
- "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
- "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
- "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
- "A String",
- ],
- "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
- "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
- "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
- "id": "A String", # Unique identifier for the resource; defined by the server (output only)
- "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-32 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
- }
-
-
-Returns:
- An object of the form:
-
- { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
- "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
- "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
- "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
- "A String",
- ],
- "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
- "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
- "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
- "id": "A String", # Unique identifier for the resource; defined by the server (output only)
- "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-32 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(project, managedZone)</code>
- <pre>Delete a previously created ManagedZone.
-
-Args:
- project: string, Identifies the project addressed by this request. (required)
- managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(project, managedZone)</code>
- <pre>Fetch the representation of an existing ManagedZone.
-
-Args:
- project: string, Identifies the project addressed by this request. (required)
- managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
-
-Returns:
- An object of the form:
-
- { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
- "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
- "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
- "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
- "A String",
- ],
- "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
- "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
- "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
- "id": "A String", # Unique identifier for the resource; defined by the server (output only)
- "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-32 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(project, pageToken=None, maxResults=None)</code>
- <pre>Enumerate ManagedZones that have been created but not yet deleted.
-
-Args:
- project: string, Identifies the project addressed by this request. (required)
- pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
- maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token.
- #
- # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
- "kind": "dns#managedZonesListResponse", # Type of resource.
- "managedZones": [ # The managed zone resources.
- { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
- "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
- "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
- "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
- "A String",
- ],
- "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
- "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
- "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
- "id": "A String", # Unique identifier for the resource; defined by the server (output only)
- "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-32 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/dns_v1beta1.changes.html b/docs/dyn/dns_v2beta1.changes.html
similarity index 73%
rename from docs/dyn/dns_v1beta1.changes.html
rename to docs/dyn/dns_v2beta1.changes.html
index 4980ef8..5c7831a 100644
--- a/docs/dyn/dns_v1beta1.changes.html
+++ b/docs/dyn/dns_v2beta1.changes.html
@@ -72,13 +72,13 @@
</style>
-<h1><a href="dns_v1beta1.html">Google Cloud DNS API</a> . <a href="dns_v1beta1.changes.html">changes</a></h1>
+<h1><a href="dns_v2beta1.html">Google Cloud DNS API</a> . <a href="dns_v2beta1.changes.html">changes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(project, managedZone, body)</a></code></p>
+ <code><a href="#create">create(project, managedZone, body, clientOperationId=None)</a></code></p>
<p class="firstline">Atomically update the ResourceRecordSet collection.</p>
<p class="toc_element">
- <code><a href="#get">get(project, managedZone, changeId)</a></code></p>
+ <code><a href="#get">get(project, managedZone, changeId, clientOperationId=None)</a></code></p>
<p class="firstline">Fetch the representation of an existing Change.</p>
<p class="toc_element">
<code><a href="#list">list(project, managedZone, pageToken=None, maxResults=None, sortBy=None, sortOrder=None)</a></code></p>
@@ -88,7 +88,7 @@
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(project, managedZone, body)</code>
+ <code class="details" id="create">create(project, managedZone, body, clientOperationId=None)</code>
<pre>Atomically update the ResourceRecordSet collection.
Args:
@@ -100,32 +100,40 @@
{ # An atomic update to a collection of ResourceRecordSets.
"deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
{ # A unit of data that will be returned by the DNS servers.
- "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
+ "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
- "type": "A String", # One of A, AAAA, SOA, MX, NS, TXT
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+ "A String",
+ ],
},
],
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
+ "status": "A String", # Status of the operation (output only).
"kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format.
+ "isServing": True or False, # If the DNS queries for the zone will be served.
+ "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
"additions": [ # Which ResourceRecordSets to add?
{ # A unit of data that will be returned by the DNS servers.
- "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
+ "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
- "type": "A String", # One of A, AAAA, SOA, MX, NS, TXT
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+ "A String",
+ ],
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
}
+ clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Returns:
An object of the form:
@@ -133,27 +141,34 @@
{ # An atomic update to a collection of ResourceRecordSets.
"deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
{ # A unit of data that will be returned by the DNS servers.
- "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
+ "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
- "type": "A String", # One of A, AAAA, SOA, MX, NS, TXT
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+ "A String",
+ ],
},
],
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
+ "status": "A String", # Status of the operation (output only).
"kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format.
+ "isServing": True or False, # If the DNS queries for the zone will be served.
+ "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
"additions": [ # Which ResourceRecordSets to add?
{ # A unit of data that will be returned by the DNS servers.
- "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
+ "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
- "type": "A String", # One of A, AAAA, SOA, MX, NS, TXT
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+ "A String",
+ ],
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
@@ -161,13 +176,14 @@
</div>
<div class="method">
- <code class="details" id="get">get(project, managedZone, changeId)</code>
+ <code class="details" id="get">get(project, managedZone, changeId, clientOperationId=None)</code>
<pre>Fetch the representation of an existing Change.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
changeId: string, The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. (required)
+ clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Returns:
An object of the form:
@@ -175,27 +191,34 @@
{ # An atomic update to a collection of ResourceRecordSets.
"deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
{ # A unit of data that will be returned by the DNS servers.
- "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
+ "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
- "type": "A String", # One of A, AAAA, SOA, MX, NS, TXT
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+ "A String",
+ ],
},
],
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
+ "status": "A String", # Status of the operation (output only).
"kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format.
+ "isServing": True or False, # If the DNS queries for the zone will be served.
+ "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
"additions": [ # Which ResourceRecordSets to add?
{ # A unit of data that will be returned by the DNS servers.
- "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
+ "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
- "type": "A String", # One of A, AAAA, SOA, MX, NS, TXT
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+ "A String",
+ ],
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
@@ -213,7 +236,7 @@
maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
sortBy: string, Sorting criterion. The only supported value is change sequence.
Allowed values
- changeSequence -
+ CHANGE_SEQUENCE -
sortOrder: string, Sorting order direction: 'ascending' or 'descending'.
Returns:
@@ -223,32 +246,42 @@
"nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token.
#
# In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size.
+ "header": { # Elements common to every response.
+ "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
+ },
"kind": "dns#changesListResponse", # Type of resource.
"changes": [ # The requested changes.
{ # An atomic update to a collection of ResourceRecordSets.
"deletions": [ # Which ResourceRecordSets to remove? Must match existing data exactly.
{ # A unit of data that will be returned by the DNS servers.
- "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
+ "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
- "type": "A String", # One of A, AAAA, SOA, MX, NS, TXT
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+ "A String",
+ ],
},
],
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
+ "status": "A String", # Status of the operation (output only).
"kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change".
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format.
+ "isServing": True or False, # If the DNS queries for the zone will be served.
+ "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format.
"additions": [ # Which ResourceRecordSets to add?
{ # A unit of data that will be returned by the DNS servers.
- "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
+ "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
- "type": "A String", # One of A, AAAA, SOA, MX, NS, TXT
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+ "A String",
+ ],
},
],
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
diff --git a/docs/dyn/dns_v2beta1.dnskeys.html b/docs/dyn/dns_v2beta1.dnskeys.html
new file mode 100644
index 0000000..95d6a9b
--- /dev/null
+++ b/docs/dyn/dns_v2beta1.dnskeys.html
@@ -0,0 +1,180 @@
+<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="dns_v2beta1.html">Google Cloud DNS API</a> . <a href="dns_v2beta1.dnskeys.html">dnskeys</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(project, managedZone, dnsKeyId, digestType=None, clientOperationId=None)</a></code></p>
+<p class="firstline">Fetch the representation of an existing DnsKey.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, managedZone, pageToken=None, digestType=None, maxResults=None)</a></code></p>
+<p class="firstline">Enumerate DnsKeys to a ResourceRecordSet collection.</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, managedZone, dnsKeyId, digestType=None, clientOperationId=None)</code>
+ <pre>Fetch the representation of an existing DnsKey.
+
+Args:
+ project: string, Identifies the project addressed by this request. (required)
+ managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
+ dnsKeyId: string, The identifier of the requested DnsKey. (required)
+ digestType: string, An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.
+ clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+
+Returns:
+ An object of the form:
+
+ { # A DNSSEC key pair.
+ "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
+ "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, managedZone, pageToken=None, digestType=None, maxResults=None)</code>
+ <pre>Enumerate DnsKeys to a ResourceRecordSet collection.
+
+Args:
+ project: string, Identifies the project addressed by this request. (required)
+ managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
+ pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
+ digestType: string, An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.
+ maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
+
+Returns:
+ An object of the form:
+
+ { # The response to a request to enumerate DnsKeys in a ManagedZone.
+ "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token.
+ #
+ # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size.
+ "header": { # Elements common to every response.
+ "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
+ },
+ "dnsKeys": [ # The requested resources.
+ { # A DNSSEC key pair.
+ "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
+ "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ },
+ ],
+ "kind": "dns#dnsKeysListResponse", # Type of resource.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/coordinate_v1.html b/docs/dyn/dns_v2beta1.html
similarity index 70%
rename from docs/dyn/coordinate_v1.html
rename to docs/dyn/dns_v2beta1.html
index f5f657d..6445953 100644
--- a/docs/dyn/coordinate_v1.html
+++ b/docs/dyn/dns_v2beta1.html
@@ -72,37 +72,37 @@
</style>
-<h1><a href="coordinate_v1.html">Google Maps Coordinate API</a></h1>
+<h1><a href="dns_v2beta1.html">Google Cloud DNS API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="coordinate_v1.customFieldDef.html">customFieldDef()</a></code>
+ <code><a href="dns_v2beta1.changes.html">changes()</a></code>
</p>
-<p class="firstline">Returns the customFieldDef Resource.</p>
+<p class="firstline">Returns the changes Resource.</p>
<p class="toc_element">
- <code><a href="coordinate_v1.jobs.html">jobs()</a></code>
+ <code><a href="dns_v2beta1.dnskeys.html">dnskeys()</a></code>
</p>
-<p class="firstline">Returns the jobs Resource.</p>
+<p class="firstline">Returns the dnskeys Resource.</p>
<p class="toc_element">
- <code><a href="coordinate_v1.location.html">location()</a></code>
+ <code><a href="dns_v2beta1.managedZoneOperations.html">managedZoneOperations()</a></code>
</p>
-<p class="firstline">Returns the location Resource.</p>
+<p class="firstline">Returns the managedZoneOperations Resource.</p>
<p class="toc_element">
- <code><a href="coordinate_v1.schedule.html">schedule()</a></code>
+ <code><a href="dns_v2beta1.managedZones.html">managedZones()</a></code>
</p>
-<p class="firstline">Returns the schedule Resource.</p>
+<p class="firstline">Returns the managedZones Resource.</p>
<p class="toc_element">
- <code><a href="coordinate_v1.team.html">team()</a></code>
+ <code><a href="dns_v2beta1.projects.html">projects()</a></code>
</p>
-<p class="firstline">Returns the team Resource.</p>
+<p class="firstline">Returns the projects Resource.</p>
<p class="toc_element">
- <code><a href="coordinate_v1.worker.html">worker()</a></code>
+ <code><a href="dns_v2beta1.resourceRecordSets.html">resourceRecordSets()</a></code>
</p>
-<p class="firstline">Returns the worker Resource.</p>
+<p class="firstline">Returns the resourceRecordSets Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/dns_v2beta1.managedZoneOperations.html b/docs/dyn/dns_v2beta1.managedZoneOperations.html
new file mode 100644
index 0000000..10b9097
--- /dev/null
+++ b/docs/dyn/dns_v2beta1.managedZoneOperations.html
@@ -0,0 +1,342 @@
+<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="dns_v2beta1.html">Google Cloud DNS API</a> . <a href="dns_v2beta1.managedZoneOperations.html">managedZoneOperations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(project, managedZone, operation, clientOperationId=None)</a></code></p>
+<p class="firstline">Fetch the representation of an existing Operation.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, managedZone, pageToken=None, maxResults=None, sortBy=None)</a></code></p>
+<p class="firstline">Enumerate Operations for the given ManagedZone.</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, managedZone, operation, clientOperationId=None)</code>
+ <pre>Fetch the representation of an existing Operation.
+
+Args:
+ project: string, Identifies the project addressed by this request. (required)
+ managedZone: string, Identifies the managed zone addressed by this request. (required)
+ operation: string, Identifies the operation addressed by this request. (required)
+ clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+
+Returns:
+ An object of the form:
+
+ { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
+ "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
+ "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation".
+ "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
+ "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
+ "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
+ "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ },
+ "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
+ "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
+ "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ },
+ },
+ "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
+ "newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+ },
+ "oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+ },
+ },
+ "user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
+ "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
+ "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
+ "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, managedZone, pageToken=None, maxResults=None, sortBy=None)</code>
+ <pre>Enumerate Operations for the given ManagedZone.
+
+Args:
+ project: string, Identifies the project addressed by this request. (required)
+ managedZone: string, Identifies the managed zone addressed by this request. (required)
+ pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
+ maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
+ sortBy: string, Sorting criterion. The only supported values are START_TIME and ID.
+ Allowed values
+ ID -
+ START_TIME -
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token.
+ #
+ # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
+ "header": { # Elements common to every response.
+ "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
+ },
+ "kind": "dns#managedZoneOperationsListResponse", # Type of resource.
+ "operations": [ # The operation resources.
+ { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
+ "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
+ "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation".
+ "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
+ "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
+ "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
+ "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ },
+ "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
+ "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
+ "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ },
+ },
+ "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
+ "newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+ },
+ "oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+ },
+ },
+ "user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
+ "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
+ "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
+ "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (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>
\ No newline at end of file
diff --git a/docs/dyn/dns_v2beta1.managedZones.html b/docs/dyn/dns_v2beta1.managedZones.html
new file mode 100644
index 0000000..6e8c553
--- /dev/null
+++ b/docs/dyn/dns_v2beta1.managedZones.html
@@ -0,0 +1,571 @@
+<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="dns_v2beta1.html">Google Cloud DNS API</a> . <a href="dns_v2beta1.managedZones.html">managedZones</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(project, body, clientOperationId=None)</a></code></p>
+<p class="firstline">Create a new ManagedZone.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, managedZone, clientOperationId=None)</a></code></p>
+<p class="firstline">Delete a previously created ManagedZone.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, managedZone, clientOperationId=None)</a></code></p>
+<p class="firstline">Fetch the representation of an existing ManagedZone.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, pageToken=None, maxResults=None, dnsName=None)</a></code></p>
+<p class="firstline">Enumerate ManagedZones that have been created but not yet deleted.</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, managedZone, body, clientOperationId=None)</a></code></p>
+<p class="firstline">Update an existing ManagedZone. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, managedZone, body, clientOperationId=None)</a></code></p>
+<p class="firstline">Update an existing ManagedZone.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(project, body, clientOperationId=None)</code>
+ <pre>Create a new ManagedZone.
+
+Args:
+ project: string, Identifies the project addressed by this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+}
+
+ clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+
+Returns:
+ An object of the form:
+
+ { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, managedZone, clientOperationId=None)</code>
+ <pre>Delete a previously created ManagedZone.
+
+Args:
+ project: string, Identifies the project addressed by this request. (required)
+ managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
+ clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+
+Returns:
+ An object of the form:
+
+ {
+ "header": { # Elements common to every response.
+ "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, managedZone, clientOperationId=None)</code>
+ <pre>Fetch the representation of an existing ManagedZone.
+
+Args:
+ project: string, Identifies the project addressed by this request. (required)
+ managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
+ clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+
+Returns:
+ An object of the form:
+
+ { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, pageToken=None, maxResults=None, dnsName=None)</code>
+ <pre>Enumerate ManagedZones that have been created but not yet deleted.
+
+Args:
+ project: string, Identifies the project addressed by this request. (required)
+ pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
+ maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
+ dnsName: string, Restricts the list to return only zones with this domain name.
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token.
+ #
+ # In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
+ "header": { # Elements common to every response.
+ "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
+ },
+ "kind": "dns#managedZonesListResponse", # Type of resource.
+ "managedZones": [ # The managed zone resources.
+ { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+ },
+ ],
+ }</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, managedZone, body, clientOperationId=None)</code>
+ <pre>Update an existing ManagedZone. This method supports patch semantics.
+
+Args:
+ project: string, Identifies the project addressed by this request. (required)
+ managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+}
+
+ clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+
+Returns:
+ An object of the form:
+
+ { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
+ "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
+ "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation".
+ "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
+ "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
+ "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
+ "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ },
+ "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
+ "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
+ "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ },
+ },
+ "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
+ "newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+ },
+ "oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+ },
+ },
+ "user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
+ "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
+ "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
+ "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, managedZone, body, clientOperationId=None)</code>
+ <pre>Update an existing ManagedZone.
+
+Args:
+ project: string, Identifies the project addressed by this request. (required)
+ managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or id. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+}
+
+ clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
+
+Returns:
+ An object of the form:
+
+ { # An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
+ "status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only).
+ "kind": "dns#operation", # Identifies what kind of resource this is. Value: the fixed string "dns#operation".
+ "dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).
+ "newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.
+ "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
+ "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ },
+ "oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.
+ "keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
+ "kind": "dns#dnsKey", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
+ "keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.
+ "creationTime": "A String", # The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
+ "publicKey": "A String", # Base64 encoded public half of this key. Output only.
+ "type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
+ "digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
+ {
+ "type": "A String", # Specifies the algorithm used to calculate this digest.
+ "digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
+ },
+ ],
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only).
+ "isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
+ },
+ },
+ "zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).
+ "newValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The post-operation ManagedZone resource.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+ },
+ "oldValue": { # A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service. # The pre-operation ManagedZone resource.
+ "kind": "dns#managedZone", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
+ "description": "A String", # A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
+ "nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the server (output only)
+ "A String",
+ ],
+ "creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339 text format. Output only.
+ "nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
+ "dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".
+ "dnssecConfig": { # DNSSEC configuration.
+ "kind": "dns#managedZoneDnsSecConfig", # Identifies what kind of resource this is. Value: the fixed string "dns#managedZoneDnsSecConfig".
+ "defaultKeySpecs": [ # Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
+ "state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.
+ "nonExistence": "A String", # Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF.
+ },
+ "id": "A String", # Unique identifier for the resource; defined by the server (output only)
+ "name": "A String", # User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
+ },
+ },
+ "user": "A String", # User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
+ "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format (output only).
+ "type": "A String", # Type of the operation. Operations include insert, update, and delete (output only).
+ "id": "A String", # Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dns_v1beta1.projects.html b/docs/dyn/dns_v2beta1.projects.html
similarity index 65%
rename from docs/dyn/dns_v1beta1.projects.html
rename to docs/dyn/dns_v2beta1.projects.html
index e8d3de5..e10f698 100644
--- a/docs/dyn/dns_v1beta1.projects.html
+++ b/docs/dyn/dns_v2beta1.projects.html
@@ -72,18 +72,19 @@
</style>
-<h1><a href="dns_v1beta1.html">Google Cloud DNS API</a> . <a href="dns_v1beta1.projects.html">projects</a></h1>
+<h1><a href="dns_v2beta1.html">Google Cloud DNS API</a> . <a href="dns_v2beta1.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#get">get(project)</a></code></p>
+ <code><a href="#get">get(project, clientOperationId=None)</a></code></p>
<p class="firstline">Fetch the representation of an existing Project.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="get">get(project)</code>
+ <code class="details" id="get">get(project, clientOperationId=None)</code>
<pre>Fetch the representation of an existing Project.
Args:
project: string, Identifies the project addressed by this request. (required)
+ clientOperationId: string, For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
Returns:
An object of the form:
@@ -94,7 +95,16 @@
"rrsetAdditionsPerChange": 42, # Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest.
"totalRrdataSizePerChange": 42, # Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes.
"resourceRecordsPerRrset": 42, # Maximum allowed number of ResourceRecords per ResourceRecordSet.
+ "dnsKeysPerManagedZone": 42, # Maximum allowed number of DnsKeys per ManagedZone.
"rrsetsPerManagedZone": 42, # Maximum allowed number of ResourceRecordSets per zone in the project.
+ "whitelistedKeySpecs": [ # DNSSEC algorithm and key length types that can be used for DnsKeys.
+ { # Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
+ "keyType": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types.
+ "keyLength": 42, # Length of the keys in bits.
+ "kind": "dns#dnsKeySpec", # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKeySpec".
+ "algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.
+ },
+ ],
"rrsetDeletionsPerChange": 42, # Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest.
"managedZones": 42, # Maximum allowed number of managed zones in the project.
},
diff --git a/docs/dyn/dns_v1beta1.resourceRecordSets.html b/docs/dyn/dns_v2beta1.resourceRecordSets.html
similarity index 86%
rename from docs/dyn/dns_v1beta1.resourceRecordSets.html
rename to docs/dyn/dns_v2beta1.resourceRecordSets.html
index e01903b..c2175f7 100644
--- a/docs/dyn/dns_v1beta1.resourceRecordSets.html
+++ b/docs/dyn/dns_v2beta1.resourceRecordSets.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="dns_v1beta1.html">Google Cloud DNS API</a> . <a href="dns_v1beta1.resourceRecordSets.html">resourceRecordSets</a></h1>
+<h1><a href="dns_v2beta1.html">Google Cloud DNS API</a> . <a href="dns_v2beta1.resourceRecordSets.html">resourceRecordSets</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(project, managedZone, name=None, pageToken=None, maxResults=None, type=None)</a></code></p>
@@ -100,18 +100,24 @@
"nextPageToken": "A String", # The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token.
#
# In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
+ "header": { # Elements common to every response.
+ "operationId": "A String", # For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
+ },
+ "kind": "dns#resourceRecordSetsListResponse", # Type of resource.
"rrsets": [ # The resource record set resources.
{ # A unit of data that will be returned by the DNS servers.
- "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
+ "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
"A String",
],
"kind": "dns#resourceRecordSet", # Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
- "type": "A String", # One of A, AAAA, SOA, MX, NS, TXT
"name": "A String", # For example, www.example.com.
"ttl": 42, # Number of seconds that this ResourceRecordSet can be cached by resolvers.
+ "type": "A String", # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
+ "signatureRrdatas": [ # As defined in RFC 4034 (section 3.2).
+ "A String",
+ ],
},
],
- "kind": "dns#resourceRecordSetsListResponse", # Type of resource.
}</pre>
</div>
diff --git a/docs/dyn/doubleclickbidmanager_v1.rubicon.html b/docs/dyn/doubleclickbidmanager_v1.rubicon.html
deleted file mode 100644
index 3948d91..0000000
--- a/docs/dyn/doubleclickbidmanager_v1.rubicon.html
+++ /dev/null
@@ -1,108 +0,0 @@
-<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="doubleclickbidmanager_v1.html">DoubleClick Bid Manager API</a> . <a href="doubleclickbidmanager_v1.rubicon.html">rubicon</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#notifyproposalchange">notifyproposalchange(body)</a></code></p>
-<p class="firstline">Update proposal upon actions of Rubicon publisher.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="notifyproposalchange">notifyproposalchange(body)</code>
- <pre>Update proposal upon actions of Rubicon publisher.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # NotifyProposalChange request.
- "action": "A String", # Action taken by publisher. One of: Accept, Decline, Append
- "notes": [ # Notes from publisher
- { # Publisher comment from Rubicon.
- "username": "A String", # Publisher user name.
- "source": "A String", # Equals "publisher" for notification from Rubicon.
- "message": "A String", # Message from publisher.
- "id": "A String", # Note id.
- "timestamp": "A String", # Time when the note was added, e.g. "2015-12-16T17:25:35.000-08:00".
- },
- ],
- "href": "A String", # URL to access proposal detail.
- "id": "A String", # Below are contents of notification from Rubicon. Proposal id.
- "token": "A String", # Deal token, available when proposal is accepted by publisher.
- }
-
-</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/drive_v2.about.html b/docs/dyn/drive_v2.about.html
index 2ea777a..c175288 100644
--- a/docs/dyn/drive_v2.about.html
+++ b/docs/dyn/drive_v2.about.html
@@ -131,7 +131,7 @@
"type": "A String", # The content type that this additional role info applies to.
},
],
- "user": { # The JSON template for a user. # The authenticated user.
+ "user": { # Information about a Drive user. # The authenticated user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -153,7 +153,7 @@
"kind": "drive#about", # This is always drive#about.
"name": "A String", # The name of the current user.
"quotaBytesTotal": "A String", # The total number of quota bytes.
- "remainingChangeIds": "A String", # The number of remaining change ids.
+ "remainingChangeIds": "A String", # The number of remaining change ids, limited to no more than 2500.
"importFormats": [ # The allowable import formats.
{
"source": "A String", # The imported file's content type to convert from.
diff --git a/docs/dyn/drive_v2.changes.html b/docs/dyn/drive_v2.changes.html
index 7285562..a3eb2eb 100644
--- a/docs/dyn/drive_v2.changes.html
+++ b/docs/dyn/drive_v2.changes.html
@@ -117,10 +117,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -133,7 +134,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -148,7 +149,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -160,7 +161,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -187,12 +188,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -206,12 +207,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -279,12 +282,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -298,12 +301,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -355,10 +359,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -371,7 +376,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -386,7 +391,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -398,7 +403,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -425,12 +430,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -444,12 +449,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -517,12 +524,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -536,12 +543,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
diff --git a/docs/dyn/drive_v2.comments.html b/docs/dyn/drive_v2.comments.html
index 6cbeaa7..898fc2e 100644
--- a/docs/dyn/drive_v2.comments.html
+++ b/docs/dyn/drive_v2.comments.html
@@ -118,13 +118,13 @@
Returns:
An object of the form:
- { # A JSON representation of a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
"kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
+ "author": { # Information about a Drive user. # The user who wrote this comment.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -136,9 +136,9 @@
},
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
"replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -183,13 +183,13 @@
body: object, The request body. (required)
The object takes the form of:
-{ # A JSON representation of a comment on a file in Google Drive.
+{ # A comment on a file in Google Drive.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
"kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
+ "author": { # Information about a Drive user. # The user who wrote this comment.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -201,9 +201,9 @@
},
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
"replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -242,13 +242,13 @@
Returns:
An object of the form:
- { # A JSON representation of a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
"kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
+ "author": { # Information about a Drive user. # The user who wrote this comment.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -260,9 +260,9 @@
},
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
"replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -312,16 +312,16 @@
Returns:
An object of the form:
- { # A JSON representation of a list of comments on a file in Google Drive.
+ { # A list of comments on a file in Google Drive.
"nextPageToken": "A String", # The token to use to request the next page of results.
"items": [ # List of comments.
- { # A JSON representation of a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
"kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
+ "author": { # Information about a Drive user. # The user who wrote this comment.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -333,9 +333,9 @@
},
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
"replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -400,13 +400,13 @@
body: object, The request body. (required)
The object takes the form of:
-{ # A JSON representation of a comment on a file in Google Drive.
+{ # A comment on a file in Google Drive.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
"kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
+ "author": { # Information about a Drive user. # The user who wrote this comment.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -418,9 +418,9 @@
},
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
"replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -459,13 +459,13 @@
Returns:
An object of the form:
- { # A JSON representation of a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
"kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
+ "author": { # Information about a Drive user. # The user who wrote this comment.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -477,9 +477,9 @@
},
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
"replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -525,13 +525,13 @@
body: object, The request body. (required)
The object takes the form of:
-{ # A JSON representation of a comment on a file in Google Drive.
+{ # A comment on a file in Google Drive.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
"kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
+ "author": { # Information about a Drive user. # The user who wrote this comment.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -543,9 +543,9 @@
},
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
"replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -584,13 +584,13 @@
Returns:
An object of the form:
- { # A JSON representation of a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
"kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
+ "author": { # Information about a Drive user. # The user who wrote this comment.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -602,9 +602,9 @@
},
"deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
"replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html
index fd23ad0..9de4c2c 100644
--- a/docs/dyn/drive_v2.files.html
+++ b/docs/dyn/drive_v2.files.html
@@ -84,6 +84,12 @@
<code><a href="#emptyTrash">emptyTrash()</a></code></p>
<p class="firstline">Permanently deletes all of the user's trashed files.</p>
<p class="toc_element">
+ <code><a href="#export">export(fileId, mimeType)</a></code></p>
+<p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content.</p>
+<p class="toc_element">
+ <code><a href="#export_media">export_media(fileId, mimeType)</a></code></p>
+<p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content.</p>
+<p class="toc_element">
<code><a href="#generateIds">generateIds(space=None, maxResults=None)</a></code></p>
<p class="firstline">Generates a set of file IDs which can be provided in insert requests.</p>
<p class="toc_element">
@@ -149,10 +155,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -165,7 +172,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -180,7 +187,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -192,7 +199,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -219,12 +226,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -238,12 +245,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -311,12 +320,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -330,12 +339,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -373,10 +383,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -389,7 +400,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -404,7 +415,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -416,7 +427,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -443,12 +454,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -462,12 +473,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -535,12 +548,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -554,12 +567,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -585,6 +599,26 @@
</div>
<div class="method">
+ <code class="details" id="export">export(fileId, mimeType)</code>
+ <pre>Exports a Google Doc to the requested MIME type and returns the exported content.
+
+Args:
+ fileId: string, The ID of the file. (required)
+ mimeType: string, The MIME type of the format requested for this export. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="export_media">export_media(fileId, mimeType)</code>
+ <pre>Exports a Google Doc to the requested MIME type and returns the exported content.
+
+Args:
+ fileId: string, The ID of the file. (required)
+ mimeType: string, The MIME type of the format requested for this export. (required)
+</pre>
+</div>
+
+<div class="method">
<code class="details" id="generateIds">generateIds(space=None, maxResults=None)</code>
<pre>Generates a set of file IDs which can be provided in insert requests.
@@ -616,7 +650,7 @@
FULL - Deprecated
revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
- updateViewedDate: boolean, Whether to update the view date after successfully retrieving the file.
+ updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
Returns:
An object of the form:
@@ -638,10 +672,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -654,7 +689,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -669,7 +704,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -681,7 +716,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -708,12 +743,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -727,12 +762,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -800,12 +837,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -819,12 +856,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -844,7 +882,7 @@
FULL - Deprecated
revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
- updateViewedDate: boolean, Whether to update the view date after successfully retrieving the file.
+ updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
Returns:
The media object as a string.
@@ -877,10 +915,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -893,7 +932,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -908,7 +947,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -920,7 +959,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -947,12 +986,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -966,12 +1005,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -1039,12 +1080,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -1058,12 +1099,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -1103,10 +1145,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -1119,7 +1162,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -1134,7 +1177,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -1146,7 +1189,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -1173,12 +1216,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -1192,12 +1235,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -1265,12 +1310,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -1284,12 +1329,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -1340,10 +1386,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -1356,7 +1403,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -1371,7 +1418,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -1383,7 +1430,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -1410,12 +1457,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -1429,12 +1476,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -1502,12 +1551,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -1521,12 +1570,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -1579,10 +1629,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -1595,7 +1646,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -1610,7 +1661,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -1622,7 +1673,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -1649,12 +1700,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -1668,12 +1719,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -1741,12 +1794,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -1760,12 +1813,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -1813,10 +1867,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -1829,7 +1884,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -1844,7 +1899,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -1856,7 +1911,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -1883,12 +1938,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -1902,12 +1957,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -1975,12 +2032,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -1994,12 +2051,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -2034,10 +2092,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2050,7 +2109,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2065,7 +2124,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2077,7 +2136,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -2104,12 +2163,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -2123,12 +2182,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -2196,12 +2257,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -2215,12 +2276,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -2255,10 +2317,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2271,7 +2334,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2286,7 +2349,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2298,7 +2361,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -2325,12 +2388,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -2344,12 +2407,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -2417,12 +2482,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -2436,12 +2501,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -2476,10 +2542,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2492,7 +2559,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2507,7 +2574,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2519,7 +2586,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -2546,12 +2613,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -2565,12 +2632,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -2638,12 +2707,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -2657,12 +2726,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -2696,10 +2766,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2712,7 +2783,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2727,7 +2798,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2739,7 +2810,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -2766,12 +2837,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -2785,12 +2856,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -2858,12 +2931,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -2877,12 +2950,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -2931,10 +3005,11 @@
"text": "A String", # The text to be indexed for this file.
},
"explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"lastModifyingUserName": "A String", # Name of the last user to modify this file.
"writersCanShare": True or False, # Whether writers can share the document with other users.
"owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
+ { # Information about a Drive user.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2947,7 +3022,7 @@
],
"ownedByMe": True or False, # Whether the file is owned by the current user.
"id": "A String", # The ID of the file.
- "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
+ "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2962,7 +3037,7 @@
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -2974,7 +3049,7 @@
},
"copyable": True or False, # Whether the file can be copied by the current user.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
+ "markedViewedByMeDate": "A String", # Deprecated.
"ownerNames": [ # Name(s) of the owner(s) of this file.
"A String",
],
@@ -3001,12 +3076,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -3020,12 +3095,14 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
+ "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
@@ -3093,12 +3170,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -3112,12 +3189,13 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
"spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"shareable": True or False, # Whether the file's sharing settings can be modified by the current user.
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Drive.
"fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.
"selfLink": "A String", # A link back to this file.
@@ -3155,7 +3233,7 @@
FULL - Deprecated
revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
- updateViewedDate: boolean, Whether to update the view date after successfully retrieving the file.
+ updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
Returns:
An object of the form:
@@ -3206,7 +3284,7 @@
FULL - Deprecated
revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
- updateViewedDate: boolean, Whether to update the view date after successfully retrieving the file.
+ updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
Returns:
The media object as a string.
diff --git a/docs/dyn/drive_v2.permissions.html b/docs/dyn/drive_v2.permissions.html
index b59b698..9d4d480 100644
--- a/docs/dyn/drive_v2.permissions.html
+++ b/docs/dyn/drive_v2.permissions.html
@@ -90,10 +90,10 @@
<code><a href="#list">list(fileId)</a></code></p>
<p class="firstline">Lists a file's permissions.</p>
<p class="toc_element">
- <code><a href="#patch">patch(fileId, permissionId, body, transferOwnership=None)</a></code></p>
+ <code><a href="#patch">patch(fileId, permissionId, body, removeExpiration=None, transferOwnership=None)</a></code></p>
<p class="firstline">Updates a permission using patch semantics.</p>
<p class="toc_element">
- <code><a href="#update">update(fileId, permissionId, body, transferOwnership=None)</a></code></p>
+ <code><a href="#update">update(fileId, permissionId, body, removeExpiration=None, transferOwnership=None)</a></code></p>
<p class="firstline">Updates a permission.</p>
<h3>Method Details</h3>
<div class="method">
@@ -122,12 +122,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -141,6 +141,7 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
}</pre>
</div>
@@ -174,12 +175,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -193,6 +194,7 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
}
sendNotificationEmails: boolean, Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.
@@ -206,12 +208,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -225,6 +227,7 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
}</pre>
</div>
@@ -245,12 +248,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -264,6 +267,7 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
},
],
"kind": "drive#permissionList", # This is always drive#permissionList.
@@ -273,7 +277,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(fileId, permissionId, body, transferOwnership=None)</code>
+ <code class="details" id="patch">patch(fileId, permissionId, body, removeExpiration=None, transferOwnership=None)</code>
<pre>Updates a permission using patch semantics.
Args:
@@ -287,12 +291,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -306,8 +310,10 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
}
+ removeExpiration: boolean, Whether to remove the expiration date.
transferOwnership: boolean, Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.
Returns:
@@ -318,12 +324,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -337,11 +343,12 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
}</pre>
</div>
<div class="method">
- <code class="details" id="update">update(fileId, permissionId, body, transferOwnership=None)</code>
+ <code class="details" id="update">update(fileId, permissionId, body, removeExpiration=None, transferOwnership=None)</code>
<pre>Updates a permission.
Args:
@@ -355,12 +362,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -374,8 +381,10 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
}
+ removeExpiration: boolean, Whether to remove the expiration date.
transferOwnership: boolean, Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.
Returns:
@@ -386,12 +395,12 @@
"domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
+ "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "photoLink": "A String", # A link to the profile photo, if available.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
@@ -405,6 +414,7 @@
"A String",
],
"selfLink": "A String", # A link back to this permission.
+ "photoLink": "A String", # A link to the profile photo, if available.
}</pre>
</div>
diff --git a/docs/dyn/drive_v2.properties.html b/docs/dyn/drive_v2.properties.html
index b15e8c7..6b13b44 100644
--- a/docs/dyn/drive_v2.properties.html
+++ b/docs/dyn/drive_v2.properties.html
@@ -82,16 +82,16 @@
<p class="firstline">Gets a property by its key.</p>
<p class="toc_element">
<code><a href="#insert">insert(fileId, body)</a></code></p>
-<p class="firstline">Adds a property to a file.</p>
+<p class="firstline">Adds a property to a file, or updates it if it already exists.</p>
<p class="toc_element">
<code><a href="#list">list(fileId)</a></code></p>
<p class="firstline">Lists a file's properties.</p>
<p class="toc_element">
<code><a href="#patch">patch(fileId, propertyKey, body, visibility=None)</a></code></p>
-<p class="firstline">Updates a property. This method supports patch semantics.</p>
+<p class="firstline">Updates a property, or adds it if it doesn't exist. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, propertyKey, body, visibility=None)</a></code></p>
-<p class="firstline">Updates a property.</p>
+<p class="firstline">Updates a property, or adds it if it doesn't exist.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(fileId, propertyKey, visibility=None)</code>
@@ -133,7 +133,7 @@
<div class="method">
<code class="details" id="insert">insert(fileId, body)</code>
- <pre>Adds a property to a file.
+ <pre>Adds a property to a file, or updates it if it already exists.
Args:
fileId: string, The ID of the file. (required)
@@ -207,7 +207,7 @@
<div class="method">
<code class="details" id="patch">patch(fileId, propertyKey, body, visibility=None)</code>
- <pre>Updates a property. This method supports patch semantics.
+ <pre>Updates a property, or adds it if it doesn't exist. This method supports patch semantics.
Args:
fileId: string, The ID of the file. (required)
@@ -251,7 +251,7 @@
<div class="method">
<code class="details" id="update">update(fileId, propertyKey, body, visibility=None)</code>
- <pre>Updates a property.
+ <pre>Updates a property, or adds it if it doesn't exist.
Args:
fileId: string, The ID of the file. (required)
diff --git a/docs/dyn/drive_v2.replies.html b/docs/dyn/drive_v2.replies.html
index 76d4fe5..a4a7b63 100644
--- a/docs/dyn/drive_v2.replies.html
+++ b/docs/dyn/drive_v2.replies.html
@@ -120,9 +120,9 @@
Returns:
An object of the form:
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -154,9 +154,9 @@
body: object, The request body. (required)
The object takes the form of:
-{ # A JSON representation of a reply to a comment on a file in Google Drive.
+{ # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -181,9 +181,9 @@
Returns:
An object of the form:
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -219,12 +219,12 @@
Returns:
An object of the form:
- { # A JSON representation of a list of replies to a comment on a file in Google Drive.
+ { # A list of replies to a comment on a file in Google Drive.
"nextPageToken": "A String", # The token to use to request the next page of results.
"items": [ # List of reply.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -276,9 +276,9 @@
body: object, The request body. (required)
The object takes the form of:
-{ # A JSON representation of a reply to a comment on a file in Google Drive.
+{ # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -303,9 +303,9 @@
Returns:
An object of the form:
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -338,9 +338,9 @@
body: object, The request body. (required)
The object takes the form of:
-{ # A JSON representation of a reply to a comment on a file in Google Drive.
+{ # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -365,9 +365,9 @@
Returns:
An object of the form:
- { # A JSON representation of a reply to a comment on a file in Google Drive.
+ { # A comment on a file in Google Drive.
"kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
+ "author": { # Information about a Drive user. # The user who wrote this reply.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
diff --git a/docs/dyn/drive_v2.revisions.html b/docs/dyn/drive_v2.revisions.html
index 7eff89c..ce9e776 100644
--- a/docs/dyn/drive_v2.revisions.html
+++ b/docs/dyn/drive_v2.revisions.html
@@ -81,9 +81,12 @@
<code><a href="#get">get(fileId, revisionId)</a></code></p>
<p class="firstline">Gets a specific revision.</p>
<p class="toc_element">
- <code><a href="#list">list(fileId)</a></code></p>
+ <code><a href="#list">list(fileId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Lists a file's revisions.</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(fileId, revisionId, body)</a></code></p>
<p class="firstline">Updates a revision. This method supports patch semantics.</p>
<p class="toc_element">
@@ -117,7 +120,7 @@
"kind": "drive#revision", # This is always drive#revision.
"publishedLink": "A String", # A link to the published revision.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -145,16 +148,19 @@
</div>
<div class="method">
- <code class="details" id="list">list(fileId)</code>
+ <code class="details" id="list">list(fileId, pageToken=None, maxResults=None)</code>
<pre>Lists a file's revisions.
Args:
fileId: string, The ID of the file. (required)
+ pageToken: string, Page token for revisions. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, Maximum number of revisions to return.
Returns:
An object of the form:
{ # A list of revisions of a file.
+ "nextPageToken": "A String", # The page token for the next page of revisions. This field will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded and pagination should be restarted from the first page of results.
"items": [ # The actual list of revisions.
{ # A revision of a file.
"mimeType": "A String", # The MIME type of the revision.
@@ -162,7 +168,7 @@
"kind": "drive#revision", # This is always drive#revision.
"publishedLink": "A String", # A link to the published revision.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -195,6 +201,20 @@
</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(fileId, revisionId, body)</code>
<pre>Updates a revision. This method supports patch semantics.
@@ -210,7 +230,7 @@
"kind": "drive#revision", # This is always drive#revision.
"publishedLink": "A String", # A link to the published revision.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -246,7 +266,7 @@
"kind": "drive#revision", # This is always drive#revision.
"publishedLink": "A String", # A link to the published revision.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -289,7 +309,7 @@
"kind": "drive#revision", # This is always drive#revision.
"publishedLink": "A String", # A link to the published revision.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
@@ -325,7 +345,7 @@
"kind": "drive#revision", # This is always drive#revision.
"publishedLink": "A String", # A link to the published revision.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
diff --git a/docs/dyn/freebase_v1.html b/docs/dyn/freebase_v1.html
deleted file mode 100644
index 80b485d..0000000
--- a/docs/dyn/freebase_v1.html
+++ /dev/null
@@ -1,266 +0,0 @@
-<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="freebase_v1.html">Freebase Search</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
-<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
-<p class="toc_element">
- <code><a href="#reconcile">reconcile(lang=None, confidence=None, name=None, prop=None, limit=None, kind=None)</a></code></p>
-<p class="firstline">Reconcile entities to Freebase open data.</p>
-<p class="toc_element">
- <code><a href="#search">search(domain=None, help=None, query=None, scoring=None, filter=None, prefixed=None, with=None, mid=None, encode=None, limit=None, type=None, as_of_time=None, stemmed=None, format=None, spell=None, exact=None, lang=None, indent=None, cursor=None, callback=None, without=None, output=None, mql_output=None)</a></code></p>
-<p class="firstline">Search Freebase open data.</p>
-<p class="toc_element">
- <code><a href="#search_media">search_media(domain=None, help=None, query=None, scoring=None, filter=None, prefixed=None, with=None, mid=None, encode=None, limit=None, type=None, as_of_time=None, stemmed=None, format=None, spell=None, exact=None, lang=None, indent=None, cursor=None, callback=None, without=None, output=None, mql_output=None)</a></code></p>
-<p class="firstline">Search Freebase open data.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
- <pre>Create a BatchHttpRequest object based on the discovery document.
-
- Args:
- callback: callable, A callback to be called for each response, of the
- form callback(id, response, exception). The first parameter is the
- request id, and the second is the deserialized response object. The
- third is an apiclient.errors.HttpError exception object if an HTTP
- error occurred while processing the request, or None if no error
- occurred.
-
- Returns:
- A BatchHttpRequest object based on the discovery document.
- </pre>
-</div>
-
-<div class="method">
- <code class="details" id="reconcile">reconcile(lang=None, confidence=None, name=None, prop=None, limit=None, kind=None)</code>
- <pre>Reconcile entities to Freebase open data.
-
-Args:
- lang: string, Languages for names and values. First language is used for display. Default is 'en'. (repeated)
- confidence: number, Required confidence for a candidate to match. Must be between .5 and 1.0
- name: string, Name of entity.
- prop: string, Property values for entity formatted as
-: (repeated)
- limit: integer, Maximum number of candidates to return.
- kind: string, Classifications of entity e.g. type, category, title. (repeated)
-
-Returns:
- An object of the form:
-
- {
- "costs": { # Server costs for reconciling.
- "hits": 42, # Total number of hits found.
- "ms": 42, # Total milliseconds spent.
- },
- "warning": [ # If filled, then there were recoverable problems that affected the request. For example, some of the properties were ignored because they either are not valid Freebase predicates or are not indexed for reconciliation. The candidates returned should be considered valid results, with the caveat that sections of the request were ignored as specified by the warning text.
- {
- "reason": "A String", # Code for identifying classes of warnings.
- "message": "A String", # Warning message to display to the user.
- "location": "A String", # Location of warning in the request e.g. invalid predicate.
- },
- ],
- "match": { # If filled, this entity is guaranteed to match at requested confidence probability (default 99%).
- "lang": "A String", # Language code that candidate and notable names are displayed in.
- "confidence": 3.14, # Percentage likelihood that this candidate is the unique matching entity. Value will be between 0.0 and 1.0
- "notable": { # Type or profession the candidate is notable for.
- "id": "A String", # MID of notable category.
- "name": "A String", # Name of notable category in specified language.
- },
- "mid": "A String", # Freebase MID of candidate entity.
- "name": "A String", # Freebase name of matching entity in specified language.
- },
- "candidate": [ # If filled, then the listed candidates are potential matches, and such should be evaluated by a more discerning algorithm or human. The matches are ordered by confidence.
- {
- "lang": "A String", # Language code that candidate and notable names are displayed in.
- "confidence": 3.14, # Percentage likelihood that this candidate is the unique matching entity. Value will be between 0.0 and 1.0
- "notable": { # Type or profession the candidate is notable for.
- "id": "A String", # MID of notable category.
- "name": "A String", # Name of notable category in specified language.
- },
- "mid": "A String", # Freebase MID of candidate entity.
- "name": "A String", # Freebase name of matching entity in specified language.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="search">search(domain=None, help=None, query=None, scoring=None, filter=None, prefixed=None, with=None, mid=None, encode=None, limit=None, type=None, as_of_time=None, stemmed=None, format=None, spell=None, exact=None, lang=None, indent=None, cursor=None, callback=None, without=None, output=None, mql_output=None)</code>
- <pre>Search Freebase open data.
-
-Args:
- domain: string, Restrict to topics with this Freebase domain id. (repeated)
- help: string, The keyword to request help on.
- Allowed values
- langs - The language codes served by the service.
- mappings - The property/path mappings supported by the filter and output request parameters.
- predicates - The predicates and path-terminating properties supported by the filter and output request parameters.
- query: string, Query term to search for.
- scoring: string, Relevance scoring algorithm to use.
- Allowed values
- entity - Use freebase and popularity entity ranking.
- freebase - Use freebase entity ranking.
- schema - Use schema ranking for properties and types.
- filter: string, A filter to apply to the query. (repeated)
- prefixed: boolean, Prefix match against names and aliases.
- with: string, A rule to match against. (repeated)
- mid: string, A mid to use instead of a query. (repeated)
- encode: string, The encoding of the response. You can use this parameter to enable html encoding.
- Allowed values
- html - Encode certain characters in the response (such as tags and ambersands) using html encoding.
- off - No encoding of the response. You should not print the results directly on an web page without html-escaping the content first.
- limit: integer, Maximum number of results to return.
- type: string, Restrict to topics with this Freebase type id. (repeated)
- as_of_time: string, A mql as_of_time value to use with mql_output queries.
- stemmed: boolean, Query on stemmed names and aliases. May not be used with prefixed.
- format: string, Structural format of the json response.
- Allowed values
- ac - Compact format useful for autocomplete/suggest UIs.
- classic - [DEPRECATED] Same format as was returned by api.freebase.com.
- entity - Basic information about the entities.
- guids - [DEPRECATED] Ordered list of a freebase guids.
- ids - Ordered list of freebase ids.
- mids - Ordered list of freebase mids.
- spell: string, Request 'did you mean' suggestions
- Allowed values
- always - Request spelling suggestions for any query at least three characters long.
- no_results - Request spelling suggestions if no results were found.
- no_spelling - Don't request spelling suggestions.
- exact: boolean, Query on exact name and keys only.
- lang: string, The code of the language to run the query with. Default is 'en'. (repeated)
- indent: boolean, Whether to indent the json results or not.
- cursor: integer, The cursor value to use for the next page of results.
- callback: string, JS method name for JSONP callbacks.
- without: string, A rule to not match against. (repeated)
- output: string, An output expression to request data from matches.
- mql_output: string, The MQL query to run againist the results to extract more data.
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="search_media">search_media(domain=None, help=None, query=None, scoring=None, filter=None, prefixed=None, with=None, mid=None, encode=None, limit=None, type=None, as_of_time=None, stemmed=None, format=None, spell=None, exact=None, lang=None, indent=None, cursor=None, callback=None, without=None, output=None, mql_output=None)</code>
- <pre>Search Freebase open data.
-
-Args:
- domain: string, Restrict to topics with this Freebase domain id. (repeated)
- help: string, The keyword to request help on.
- Allowed values
- langs - The language codes served by the service.
- mappings - The property/path mappings supported by the filter and output request parameters.
- predicates - The predicates and path-terminating properties supported by the filter and output request parameters.
- query: string, Query term to search for.
- scoring: string, Relevance scoring algorithm to use.
- Allowed values
- entity - Use freebase and popularity entity ranking.
- freebase - Use freebase entity ranking.
- schema - Use schema ranking for properties and types.
- filter: string, A filter to apply to the query. (repeated)
- prefixed: boolean, Prefix match against names and aliases.
- with: string, A rule to match against. (repeated)
- mid: string, A mid to use instead of a query. (repeated)
- encode: string, The encoding of the response. You can use this parameter to enable html encoding.
- Allowed values
- html - Encode certain characters in the response (such as tags and ambersands) using html encoding.
- off - No encoding of the response. You should not print the results directly on an web page without html-escaping the content first.
- limit: integer, Maximum number of results to return.
- type: string, Restrict to topics with this Freebase type id. (repeated)
- as_of_time: string, A mql as_of_time value to use with mql_output queries.
- stemmed: boolean, Query on stemmed names and aliases. May not be used with prefixed.
- format: string, Structural format of the json response.
- Allowed values
- ac - Compact format useful for autocomplete/suggest UIs.
- classic - [DEPRECATED] Same format as was returned by api.freebase.com.
- entity - Basic information about the entities.
- guids - [DEPRECATED] Ordered list of a freebase guids.
- ids - Ordered list of freebase ids.
- mids - Ordered list of freebase mids.
- spell: string, Request 'did you mean' suggestions
- Allowed values
- always - Request spelling suggestions for any query at least three characters long.
- no_results - Request spelling suggestions if no results were found.
- no_spelling - Don't request spelling suggestions.
- exact: boolean, Query on exact name and keys only.
- lang: string, The code of the language to run the query with. Default is 'en'. (repeated)
- indent: boolean, Whether to indent the json results or not.
- cursor: integer, The cursor value to use for the next page of results.
- callback: string, JS method name for JSONP callbacks.
- without: string, A rule to not match against. (repeated)
- output: string, An output expression to request data from matches.
- mql_output: string, The MQL query to run againist the results to extract more data.
-</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/fusiontables_v1.column.html b/docs/dyn/fusiontables_v1.column.html
index 3258943..ddbf5dd 100644
--- a/docs/dyn/fusiontables_v1.column.html
+++ b/docs/dyn/fusiontables_v1.column.html
@@ -184,7 +184,7 @@
An object of the form:
{ # Represents a list of columns in a table.
- "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more tokens left.
+ "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more pages left.
"items": [ # List of all requested columns.
{ # Specifies the id, name and type of a column in a table.
"kind": "fusiontables#column", # Type name: a template for an individual column.
diff --git a/docs/dyn/fusiontables_v1.html b/docs/dyn/fusiontables_v1.html
index 0247ee8..c02fbd2 100644
--- a/docs/dyn/fusiontables_v1.html
+++ b/docs/dyn/fusiontables_v1.html
@@ -104,4 +104,25 @@
</p>
<p class="firstline">Returns the template Resource.</p>
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/fusiontables_v1.style.html b/docs/dyn/fusiontables_v1.style.html
index f2d1e75..8c34ad8 100644
--- a/docs/dyn/fusiontables_v1.style.html
+++ b/docs/dyn/fusiontables_v1.style.html
@@ -643,7 +643,7 @@
An object of the form:
{ # Represents a list of styles for a given table.
- "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more styles left.
+ "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more pages left.
"items": [ # All requested style settings.
{ # Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId.
"markerOptions": { # Represents a PointStyle within a StyleSetting # Style definition for points in the table.
diff --git a/docs/dyn/fusiontables_v1.table.html b/docs/dyn/fusiontables_v1.table.html
index 86bcbcc..6cba52c 100644
--- a/docs/dyn/fusiontables_v1.table.html
+++ b/docs/dyn/fusiontables_v1.table.html
@@ -338,7 +338,7 @@
An object of the form:
{ # Represents a list of tables.
- "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more tokens left.
+ "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more pages left.
"items": [ # List of all requested tables.
{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
"kind": "fusiontables#table", # Type name: a template for an individual table.
diff --git a/docs/dyn/fusiontables_v1.task.html b/docs/dyn/fusiontables_v1.task.html
index 5cd417d..47efde0 100644
--- a/docs/dyn/fusiontables_v1.task.html
+++ b/docs/dyn/fusiontables_v1.task.html
@@ -108,11 +108,11 @@
Returns:
An object of the form:
- { # Specifies the id, name and type of a task in a table.
- "started": True or False, # False while the table is busy with some other task.
+ { # Specifies the identifier, name, and type of a task in a table.
+ "started": True or False, # false while the table is busy with some other task. true if this background task is currently running.
"progress": "A String", # An indication of task progress.
- "kind": "fusiontables#task", # Type name: a template for an individual task.
- "type": "A String",
+ "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
+ "type": "A String", # Type of background task. One of DELETE_ROWS Deletes one or more rows from the table. ADD_ROWS "Adds one or more rows to a table. Includes importing data into a new table and importing more rows into an existing table. ADD_COLUMN Adds a new column to the table. CHANGE_TYPE Changes the type of a column.
"taskId": "A String", # Identifier for the task.
}</pre>
</div>
@@ -130,18 +130,18 @@
Returns:
An object of the form:
- { # Represents a list of tasks in a table.
- "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more tokens left.
+ { # Represents a list of tasks for a table.
+ "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more pages left.
"items": [ # List of all requested tasks.
- { # Specifies the id, name and type of a task in a table.
- "started": True or False, # False while the table is busy with some other task.
+ { # Specifies the identifier, name, and type of a task in a table.
+ "started": True or False, # false while the table is busy with some other task. true if this background task is currently running.
"progress": "A String", # An indication of task progress.
- "kind": "fusiontables#task", # Type name: a template for an individual task.
- "type": "A String",
+ "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
+ "type": "A String", # Type of background task. One of DELETE_ROWS Deletes one or more rows from the table. ADD_ROWS "Adds one or more rows to a table. Includes importing data into a new table and importing more rows into an existing table. ADD_COLUMN Adds a new column to the table. CHANGE_TYPE Changes the type of a column.
"taskId": "A String", # Identifier for the task.
},
],
- "kind": "fusiontables#taskList", # Type name: a list of all tasks.
+ "kind": "fusiontables#taskList", # Type of the resource. This is always "fusiontables#taskList".
"totalItems": 42, # Total number of tasks for the table.
}</pre>
</div>
diff --git a/docs/dyn/fusiontables_v1.template.html b/docs/dyn/fusiontables_v1.template.html
index f887c49..9f10deb 100644
--- a/docs/dyn/fusiontables_v1.template.html
+++ b/docs/dyn/fusiontables_v1.template.html
@@ -178,7 +178,7 @@
An object of the form:
{ # Represents a list of templates for a given table.
- "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more tokens left.
+ "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more pages left.
"items": [ # List of all requested templates.
{ # Represents the contents of InfoWindow templates.
"body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
diff --git a/docs/dyn/gan_v1beta1.advertisers.html b/docs/dyn/gan_v1beta1.advertisers.html
deleted file mode 100644
index 0ff960c..0000000
--- a/docs/dyn/gan_v1beta1.advertisers.html
+++ /dev/null
@@ -1,219 +0,0 @@
-<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="gan_v1beta1.html">Google Affiliate Network API</a> . <a href="gan_v1beta1.advertisers.html">advertisers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(role, roleId, advertiserId=None)</a></code></p>
-<p class="firstline">Retrieves data about a single advertiser if that the requesting advertiser/publisher has access to it. Only publishers can lookup advertisers. Advertisers can request information about themselves by omitting the advertiserId query parameter.</p>
-<p class="toc_element">
- <code><a href="#list">list(role, roleId, relationshipStatus=None, pageToken=None, minNinetyDayEpc=None, advertiserCategory=None, maxResults=None, minSevenDayEpc=None, minPayoutRank=None)</a></code></p>
-<p class="firstline">Retrieves data about all advertisers that the requesting advertiser/publisher has access 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="get">get(role, roleId, advertiserId=None)</code>
- <pre>Retrieves data about a single advertiser if that the requesting advertiser/publisher has access to it. Only publishers can lookup advertisers. Advertisers can request information about themselves by omitting the advertiserId query parameter.
-
-Args:
- role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
- Allowed values
- advertisers - The requester is requesting as an advertiser.
- publishers - The requester is requesting as a publisher.
- roleId: string, The ID of the requesting advertiser or publisher. (required)
- advertiserId: string, The ID of the advertiser to look up. Optional.
-
-Returns:
- An object of the form:
-
- { # An AdvertiserResource.
- "category": "A String", # Category that this advertiser belongs to. A valid list of categories can be found here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581
- "contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.
- "kind": "gan#advertiser", # The kind for an advertiser.
- "siteUrl": "A String", # URL of the website this advertiser advertises from.
- "contactPhone": "A String", # Phone that this advertiser would like publishers to contact them with.
- "description": "A String", # Description of the website the advertiser advertises from.
- "merchantCenterIds": [ # List of merchant center ids for this advertiser
- "A String",
- ],
- "defaultLinkId": "A String", # The default link id for this advertiser.
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "commissionDuration": 42, # The longest possible length of a commission (how long the cookies on the customer's browser last before they expire).
- "status": "A String", # The status of the requesting publisher's relationship this advertiser.
- "payoutRank": "A String", # A rank based on commissions paid to publishers over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid).
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "allowPublisherCreatedLinks": True or False, # True if the advertiser allows publisher created links, otherwise false.
- "item": # Object with schema name: Advertiser # The requested advertiser.
- "joinDate": "A String", # Date that this advertiser was approved as a Google Affiliate Network advertiser.
- "logoUrl": "A String", # URL to the logo this advertiser uses on the Google Affiliate Network.
- "redirectDomains": [ # List of redirect URLs for this advertiser
- "A String",
- ],
- "id": "A String", # The ID of this advertiser.
- "productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.
- "name": "A String", # The name of this advertiser.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(role, roleId, relationshipStatus=None, pageToken=None, minNinetyDayEpc=None, advertiserCategory=None, maxResults=None, minSevenDayEpc=None, minPayoutRank=None)</code>
- <pre>Retrieves data about all advertisers that the requesting advertiser/publisher has access to.
-
-Args:
- role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
- Allowed values
- advertisers - The requester is requesting as an advertiser.
- publishers - The requester is requesting as a publisher.
- roleId: string, The ID of the requesting advertiser or publisher. (required)
- relationshipStatus: string, Filters out all advertisers for which do not have the given relationship status with the requesting publisher.
- Allowed values
- approved - An advertiser that has approved your application.
- available - An advertiser program that's accepting new publishers.
- deactivated - Deactivated means either the advertiser has removed you from their program, or it could also mean that you chose to remove yourself from the advertiser's program.
- declined - An advertiser that did not approve your application.
- pending - An advertiser program that you've already applied to, but they haven't yet decided to approve or decline your application.
- pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
- minNinetyDayEpc: number, Filters out all advertisers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
- advertiserCategory: string, Caret(^) delimted list of advertiser categories. Valid categories are defined here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581. Filters out all advertisers not in one of the given advertiser categories. Optional.
- maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.
- minSevenDayEpc: number, Filters out all advertisers that have a seven day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
- minPayoutRank: integer, A value between 1 and 4, where 1 represents the quartile of advertisers with the lowest ranks and 4 represents the quartile of advertisers with the highest ranks. Filters out all advertisers with a lower rank than the given quartile. For example if a 2 was given only advertisers with a payout rank of 25 or higher would be included. Optional.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
- "items": [ # The advertiser list.
- { # An AdvertiserResource.
- "category": "A String", # Category that this advertiser belongs to. A valid list of categories can be found here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581
- "contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.
- "kind": "gan#advertiser", # The kind for an advertiser.
- "siteUrl": "A String", # URL of the website this advertiser advertises from.
- "contactPhone": "A String", # Phone that this advertiser would like publishers to contact them with.
- "description": "A String", # Description of the website the advertiser advertises from.
- "merchantCenterIds": [ # List of merchant center ids for this advertiser
- "A String",
- ],
- "defaultLinkId": "A String", # The default link id for this advertiser.
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "commissionDuration": 42, # The longest possible length of a commission (how long the cookies on the customer's browser last before they expire).
- "status": "A String", # The status of the requesting publisher's relationship this advertiser.
- "payoutRank": "A String", # A rank based on commissions paid to publishers over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid).
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "allowPublisherCreatedLinks": True or False, # True if the advertiser allows publisher created links, otherwise false.
- "item": # Object with schema name: Advertiser # The requested advertiser.
- "joinDate": "A String", # Date that this advertiser was approved as a Google Affiliate Network advertiser.
- "logoUrl": "A String", # URL to the logo this advertiser uses on the Google Affiliate Network.
- "redirectDomains": [ # List of redirect URLs for this advertiser
- "A String",
- ],
- "id": "A String", # The ID of this advertiser.
- "productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.
- "name": "A String", # The name of this advertiser.
- },
- ],
- "kind": "gan#advertisers", # The kind for a page of advertisers.
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/gan_v1beta1.ccOffers.html b/docs/dyn/gan_v1beta1.ccOffers.html
deleted file mode 100644
index a40868b..0000000
--- a/docs/dyn/gan_v1beta1.ccOffers.html
+++ /dev/null
@@ -1,197 +0,0 @@
-<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="gan_v1beta1.html">Google Affiliate Network API</a> . <a href="gan_v1beta1.ccOffers.html">ccOffers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(publisher, advertiser=None, projection=None)</a></code></p>
-<p class="firstline">Retrieves credit card offers for the given publisher.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(publisher, advertiser=None, projection=None)</code>
- <pre>Retrieves credit card offers for the given publisher.
-
-Args:
- publisher: string, The ID of the publisher in question. (required)
- advertiser: string, The advertiser ID of a card issuer whose offers to include. Optional, may be repeated. (repeated)
- projection: string, The set of fields to return.
- Allowed values
- full - Include all offer fields. This is the default.
- summary - Include only the basic fields needed to display an offer.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # The credit card offers.
- { # A credit card offer. There are many possible result fields. We provide two different views of the data, or "projections." The "full" projection includes every result field. And the "summary" projection, which is the default, includes a smaller subset of the fields. The fields included in the summary projection are marked as such in their descriptions.
- "luggageInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
- "creditLimitMin": 3.14, # The low end for credit limits the issuer imposes on recipients of this card.
- "cardName": "A String", # The issuer's name for the card, including any trademark or service mark designators. A summary field.
- "creditLimitMax": 3.14, # The high end for credit limits the issuer imposes on recipients of this card.
- "gracePeriodDisplay": "A String", # Text describing the grace period before finance charges apply. A summary field.
- "offerId": "A String", # This offer's ID. A summary field.
- "rewardUnit": "A String", # For cards with rewards programs, the unit of reward. For example, miles, cash back, points.
- "minPurchaseRate": 3.14, # The lowest interest rate the issuer charges on this card. Expressed as an absolute number, not as a percentage.
- "cardBenefits": [ # A list of what the issuer thinks are the most important benefits of the card. Usually summarizes the rewards program, if there is one. A summary field.
- "A String",
- ],
- "rewards": [ # For cards with rewards programs, detailed rules about how the program works.
- {
- "category": "A String", # The kind of purchases covered by this rule.
- "minRewardTier": 3.14, # The minimum purchase amount in the given category before this rule applies.
- "maxRewardTier": 3.14, # The maximum purchase amount in the given category for this rule to apply.
- "expirationMonths": 3.14, # How long rewards granted by this rule last.
- "amount": 3.14, # The number of units rewarded per purchase dollar.
- "additionalDetails": "A String", # Other limits, for example, if this rule only applies during an introductory period.
- },
- ],
- "offersImmediateCashReward": True or False, # Whether a cash reward program lets you get cash back sooner than end of year or other longish period.
- "travelInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
- "returnedPaymentFee": "A String", # Text describing the fee for a payment that doesn't clear. A summary field.
- "kind": "gan#ccOffer", # The kind for one credit card offer. A summary field.
- "issuer": "A String", # Name of card issuer. A summary field.
- "maxPurchaseRate": 3.14, # The highest interest rate the issuer charges on this card. Expressed as an absolute number, not as a percentage.
- "minimumFinanceCharge": "A String", # Text describing how much missing the grace period will cost.
- "existingCustomerOnly": True or False, # Whether this card is only available to existing customers of the issuer.
- "annualFeeDisplay": "A String", # Text describing the annual fee, including any difference for the first year. A summary field.
- "initialSetupAndProcessingFee": "A String", # Fee for setting up the card.
- "issuerId": "A String", # The Google Affiliate Network ID of the advertiser making this offer.
- "purchaseRateAdditionalDetails": "A String", # Text describing any additional details for the purchase rate. A summary field.
- "prohibitedCategories": [ # Categories in which the issuer does not wish the card to be displayed. A summary field.
- "A String",
- ],
- "fraudLiability": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
- "cashAdvanceTerms": "A String", # Text describing the terms for cash advances. A summary field.
- "landingPageUrl": "A String", # The link to the issuer's page for this card. A summary field.
- "introCashAdvanceTerms": "A String", # Text describing the terms for introductory period cash advances. A summary field.
- "rewardsExpire": True or False, # Whether accumulated rewards ever expire.
- "introPurchaseTerms": "A String", # Text describing the terms for introductory period purchases. A summary field.
- "defaultFees": [ # Fees for defaulting on your payments.
- {
- "category": "A String", # The type of charge, for example Purchases.
- "maxRate": 3.14, # The highest rate the issuer may charge for defaulting on debt in this category. Expressed as an absolute number, not as a percentage.
- "minRate": 3.14, # The lowest rate the issuer may charge for defaulting on debt in this category. Expressed as an absolute number, not as a percentage.
- "rateType": "A String", # Fixed or variable.
- },
- ],
- "extendedWarranty": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
- "emergencyInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
- "firstYearAnnualFee": 3.14, # The annual fee for the first year, if different from the ongoing fee. Optional.
- "trackingUrl": "A String", # The link to ping to register a click on this offer. A summary field.
- "latePaymentFee": "A String", # Text describing how much a late payment will cost, eg "up to $35." A summary field.
- "overLimitFee": "A String", # Fee for exceeding the card's charge limit.
- "cardType": "A String", # What kind of credit card this is, for example secured or unsecured.
- "approvedCategories": [ # Possible categories for this card, eg "Low Interest" or "Good." A summary field.
- "A String",
- ],
- "rewardPartner": "A String", # The company that redeems the rewards, if different from the issuer.
- "introBalanceTransferTerms": "A String", # Text describing the terms for introductory period balance transfers. A summary field.
- "foreignCurrencyTransactionFee": "A String", # Fee for each transaction involving a foreign currency.
- "annualFee": 3.14, # The ongoing annual fee, in dollars.
- "issuerWebsite": "A String", # The generic link to the issuer's site.
- "variableRatesUpdateFrequency": "A String", # How often variable rates are updated.
- "carRentalInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
- "additionalCardBenefits": [ # More marketing copy about the card's benefits. A summary field.
- "A String",
- ],
- "ageMinimum": 3.14, # The youngest a recipient of this card may be.
- "balanceComputationMethod": "A String", # Text describing how the balance is computed. A summary field.
- "aprDisplay": "A String", # Text describing the purchase APR. A summary field.
- "additionalCardHolderFee": "A String", # Any extra fees levied on card holders.
- "variableRatesLastUpdated": "A String", # When variable rates were last updated.
- "network": "A String", # Which network (eg Visa) the card belongs to. A summary field.
- "purchaseRateType": "A String", # Fixed or variable.
- "statementCopyFee": "A String", # Fee for requesting a copy of your statement.
- "rewardsHaveBlackoutDates": True or False, # For airline miles rewards, tells whether blackout dates apply to the miles.
- "creditRatingDisplay": "A String", # Text describing the credit ratings required for recipients of this card, for example "Excellent/Good." A summary field.
- "flightAccidentInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
- "annualRewardMaximum": 3.14, # The largest number of units you may accumulate in a year.
- "balanceTransferTerms": "A String", # Text describing the terms for balance transfers. A summary field.
- "bonusRewards": [ # For cards with rewards programs, extra circumstances whereby additional rewards may be granted.
- {
- "amount": 3.14, # How many units of reward will be granted.
- "details": "A String", # The circumstances under which this rule applies, for example, booking a flight via Orbitz.
- },
- ],
- "imageUrl": "A String", # The link to the image of the card that is shown on Connect Commerce. A summary field.
- "ageMinimumDetails": "A String", # Text describing the details of the age minimum restriction.
- "disclaimer": "A String", # A notice that, if present, is referenced via an asterisk by many of the other summary fields. If this field is present, it will always start with an asterisk ("*"), and must be prominently displayed with the offer. A summary field.
- },
- ],
- "kind": "gan#ccOffers", # The kind for a page of credit card offers.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/gan_v1beta1.events.html b/docs/dyn/gan_v1beta1.events.html
deleted file mode 100644
index 3831857..0000000
--- a/docs/dyn/gan_v1beta1.events.html
+++ /dev/null
@@ -1,206 +0,0 @@
-<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="gan_v1beta1.html">Google Affiliate Network API</a> . <a href="gan_v1beta1.events.html">events</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(role, roleId, orderId=None, chargeType=None, linkId=None, advertiserId=None, sku=None, pageToken=None, productCategory=None, modifyDateMin=None, type=None, status=None, modifyDateMax=None, eventDateMin=None, maxResults=None, eventDateMax=None, memberId=None, publisherId=None)</a></code></p>
-<p class="firstline">Retrieves event data for a given advertiser/publisher.</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(role, roleId, orderId=None, chargeType=None, linkId=None, advertiserId=None, sku=None, pageToken=None, productCategory=None, modifyDateMin=None, type=None, status=None, modifyDateMax=None, eventDateMin=None, maxResults=None, eventDateMax=None, memberId=None, publisherId=None)</code>
- <pre>Retrieves event data for a given advertiser/publisher.
-
-Args:
- role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
- Allowed values
- advertisers - The requester is requesting as an advertiser.
- publishers - The requester is requesting as a publisher.
- roleId: string, The ID of the requesting advertiser or publisher. (required)
- orderId: string, Caret(^) delimited list of order IDs. Filters out all events that do not reference one of the given order IDs. Optional.
- chargeType: string, Filters out all charge events that are not of the given charge type. Valid values: 'other', 'slotting_fee', 'monthly_minimum', 'tier_bonus', 'credit', 'debit'. Optional.
- Allowed values
- credit - A credit increases the publisher's payout amount and decreases the advertiser's invoice amount.
- debit - A debit reduces the publisher's payout and increases the advertiser's invoice amount.
- monthly_minimum - A payment made to Google by an advertiser as a minimum monthly network fee.
- other - Catch all. Default if unset
- slotting_fee - A one time payment made from an advertiser to a publisher.
- tier_bonus - A payment from an advertiser to a publisher for the publisher maintaining a high tier level
- linkId: string, Caret(^) delimited list of link IDs. Filters out all events that do not reference one of the given link IDs. Optional.
- advertiserId: string, Caret(^) delimited list of advertiser IDs. Filters out all events that do not reference one of the given advertiser IDs. Only used when under publishers role. Optional.
- sku: string, Caret(^) delimited list of SKUs. Filters out all events that do not reference one of the given SKU. Optional.
- pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
- productCategory: string, Caret(^) delimited list of product categories. Filters out all events that do not reference a product in one of the given product categories. Optional.
- modifyDateMin: string, Filters out all events modified earlier than given date. Optional. Defaults to 24 hours before the current modifyDateMax, if modifyDateMax is explicitly set.
- type: string, Filters out all events that are not of the given type. Valid values: 'action', 'transaction', 'charge'. Optional.
- Allowed values
- action - The completion of an application, sign-up, or other process. For example, an action occurs if a user clicks an ad for a credit card and completes an application for that card.
- charge - A charge event is typically a payment between an advertiser, publisher or Google.
- transaction - A conversion event, typically an e-commerce transaction. Some advertisers use a transaction to record other types of events, such as magazine subscriptions.
- status: string, Filters out all events that do not have the given status. Valid values: 'active', 'canceled'. Optional.
- Allowed values
- active - Event is currently active.
- canceled - Event is currently canceled.
- modifyDateMax: string, Filters out all events modified later than given date. Optional. Defaults to 24 hours after modifyDateMin, if modifyDateMin is explicitly set.
- eventDateMin: string, Filters out all events earlier than given date. Optional. Defaults to 24 hours from current date/time.
- maxResults: integer, Max number of offers to return in this page. Optional. Defaults to 20.
- eventDateMax: string, Filters out all events later than given date. Optional. Defaults to 24 hours after eventMin.
- memberId: string, Caret(^) delimited list of member IDs. Filters out all events that do not reference one of the given member IDs. Optional.
- publisherId: string, Caret(^) delimited list of publisher IDs. Filters out all events that do not reference one of the given publishers IDs. Only used when under advertiser role. Optional.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
- "items": [ # The event list.
- { # An EventResource.
- "networkFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the Google Affiliate Network.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "advertiserName": "A String", # The name of the advertiser for this event.
- "kind": "gan#event", # The kind for one event.
- "modifyDate": "A String", # The date-time this event was last modified as a RFC 3339 date-time value.
- "type": "A String", # Type of the event (action|transaction|charge).
- "orderId": "A String", # The order ID for this event. Only returned for conversion events.
- "publisherName": "A String", # The name of the publisher for this event.
- "memberId": "A String", # The ID of the member attached to this event. Only returned for conversion events.
- "advertiserId": "A String", # The ID of advertiser for this event.
- "status": "A String", # Status of the event (active|canceled). Only returned for charge and conversion events.
- "chargeId": "A String", # The charge ID for this event. Only returned for charge events.
- "products": [ # Products associated with the event.
- {
- "networkFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the Google Affiliate Network for this product.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "sku": "A String", # Sku of this product.
- "categoryName": "A String", # Name of the category this product belongs to.
- "skuName": "A String", # Sku name of this product.
- "publisherFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the publisehr for this product.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "earnings": { # An ApiMoneyProto. # Amount earned by the publisher on this product.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "unitPrice": { # An ApiMoneyProto. # Price per unit of this product.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "categoryId": "A String", # Id of the category this product belongs to.
- "quantity": "A String", # Quantity of this product bought/exchanged.
- },
- ],
- "earnings": { # An ApiMoneyProto. # Earnings by the publisher.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "chargeType": "A String", # Charge type of the event (other|slotting_fee|monthly_minimum|tier_bonus|debit|credit). Only returned for charge events.
- "publisherFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the publisher.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "commissionableSales": { # An ApiMoneyProto. # Amount of money exchanged during the transaction. Only returned for charge and conversion events.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "publisherId": "A String", # The ID of the publisher for this event.
- "eventDate": "A String", # The date-time this event was initiated as a RFC 3339 date-time value.
- },
- ],
- "kind": "gan#events", # The kind for a page of events.
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/gan_v1beta1.links.html b/docs/dyn/gan_v1beta1.links.html
deleted file mode 100644
index db91bd8..0000000
--- a/docs/dyn/gan_v1beta1.links.html
+++ /dev/null
@@ -1,399 +0,0 @@
-<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="gan_v1beta1.html">Google Affiliate Network API</a> . <a href="gan_v1beta1.links.html">links</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(role, roleId, linkId)</a></code></p>
-<p class="firstline">Retrieves data about a single link if the requesting advertiser/publisher has access to it. Advertisers can look up their own links. Publishers can look up visible links or links belonging to advertisers they are in a relationship with.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(role, roleId, body)</a></code></p>
-<p class="firstline">Inserts a new link.</p>
-<p class="toc_element">
- <code><a href="#list">list(role, roleId, linkType=None, promotionType=None, createDateMax=None, advertiserId=None, pageToken=None, relationshipStatus=None, maxResults=None, authorship=None, startDateMin=None, assetSize=None, searchText=None, startDateMax=None, createDateMin=None)</a></code></p>
-<p class="firstline">Retrieves all links that match the query parameters.</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(role, roleId, linkId)</code>
- <pre>Retrieves data about a single link if the requesting advertiser/publisher has access to it. Advertisers can look up their own links. Publishers can look up visible links or links belonging to advertisers they are in a relationship with.
-
-Args:
- role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
- Allowed values
- advertisers - The requester is requesting as an advertiser.
- publishers - The requester is requesting as a publisher.
- roleId: string, The ID of the requesting advertiser or publisher. (required)
- linkId: string, The ID of the link to look up. (required)
-
-Returns:
- An object of the form:
-
- { # A LinkResource.
- "isActive": True or False, # Flag for if this link is active.
- "linkType": "A String", # The link type.
- "kind": "gan#link", # The kind for one entity.
- "endDate": "A String", # Date that this link becomes inactive.
- "description": "A String", # Description.
- "name": "A String", # The logical name for this link.
- "specialOffers": { # Special offers on the link.
- "priceCut": { # An ApiMoneyProto. # Price cut on the purchase
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "priceCutMin": { # An ApiMoneyProto. # Minimum purchase amount for price cut promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeShipping": True or False, # Whether there is free shipping
- "promotionCodes": [ # List of promotion code associated with the link
- "A String",
- ],
- "percentOff": 3.14, # Percent off on the purchase
- "percentOffMin": { # An ApiMoneyProto. # Minimum purchase amount for percent off promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeGift": True or False, # Whether there is a free gift
- "freeShippingMin": { # An ApiMoneyProto. # Minimum purchase amount for free shipping promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- },
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "createDate": "A String", # Date that this link was created.
- "imageAltText": "A String", # image alt text.
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "advertiserId": "A String", # The advertiser id for the advertiser who owns this link.
- "id": "A String", # The ID of this link.
- "impressionTrackingUrl": "A String", # Tracking url for impressions.
- "promotionType": "A String", # Promotion Type
- "duration": "A String", # Duration
- "authorship": "A String", # Authorship
- "startDate": "A String", # Date that this link becomes active.
- "availability": "A String", # Availability.
- "clickTrackingUrl": "A String", # Tracking url for clicks.
- "destinationUrl": "A String", # The destination URL for the link.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(role, roleId, body)</code>
- <pre>Inserts a new link.
-
-Args:
- role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
- Allowed values
- advertisers - The requester is requesting as an advertiser.
- publishers - The requester is requesting as a publisher.
- roleId: string, The ID of the requesting advertiser or publisher. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A LinkResource.
- "isActive": True or False, # Flag for if this link is active.
- "linkType": "A String", # The link type.
- "kind": "gan#link", # The kind for one entity.
- "endDate": "A String", # Date that this link becomes inactive.
- "description": "A String", # Description.
- "name": "A String", # The logical name for this link.
- "specialOffers": { # Special offers on the link.
- "priceCut": { # An ApiMoneyProto. # Price cut on the purchase
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "priceCutMin": { # An ApiMoneyProto. # Minimum purchase amount for price cut promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeShipping": True or False, # Whether there is free shipping
- "promotionCodes": [ # List of promotion code associated with the link
- "A String",
- ],
- "percentOff": 3.14, # Percent off on the purchase
- "percentOffMin": { # An ApiMoneyProto. # Minimum purchase amount for percent off promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeGift": True or False, # Whether there is a free gift
- "freeShippingMin": { # An ApiMoneyProto. # Minimum purchase amount for free shipping promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- },
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "createDate": "A String", # Date that this link was created.
- "imageAltText": "A String", # image alt text.
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "advertiserId": "A String", # The advertiser id for the advertiser who owns this link.
- "id": "A String", # The ID of this link.
- "impressionTrackingUrl": "A String", # Tracking url for impressions.
- "promotionType": "A String", # Promotion Type
- "duration": "A String", # Duration
- "authorship": "A String", # Authorship
- "startDate": "A String", # Date that this link becomes active.
- "availability": "A String", # Availability.
- "clickTrackingUrl": "A String", # Tracking url for clicks.
- "destinationUrl": "A String", # The destination URL for the link.
- }
-
-
-Returns:
- An object of the form:
-
- { # A LinkResource.
- "isActive": True or False, # Flag for if this link is active.
- "linkType": "A String", # The link type.
- "kind": "gan#link", # The kind for one entity.
- "endDate": "A String", # Date that this link becomes inactive.
- "description": "A String", # Description.
- "name": "A String", # The logical name for this link.
- "specialOffers": { # Special offers on the link.
- "priceCut": { # An ApiMoneyProto. # Price cut on the purchase
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "priceCutMin": { # An ApiMoneyProto. # Minimum purchase amount for price cut promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeShipping": True or False, # Whether there is free shipping
- "promotionCodes": [ # List of promotion code associated with the link
- "A String",
- ],
- "percentOff": 3.14, # Percent off on the purchase
- "percentOffMin": { # An ApiMoneyProto. # Minimum purchase amount for percent off promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeGift": True or False, # Whether there is a free gift
- "freeShippingMin": { # An ApiMoneyProto. # Minimum purchase amount for free shipping promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- },
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "createDate": "A String", # Date that this link was created.
- "imageAltText": "A String", # image alt text.
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "advertiserId": "A String", # The advertiser id for the advertiser who owns this link.
- "id": "A String", # The ID of this link.
- "impressionTrackingUrl": "A String", # Tracking url for impressions.
- "promotionType": "A String", # Promotion Type
- "duration": "A String", # Duration
- "authorship": "A String", # Authorship
- "startDate": "A String", # Date that this link becomes active.
- "availability": "A String", # Availability.
- "clickTrackingUrl": "A String", # Tracking url for clicks.
- "destinationUrl": "A String", # The destination URL for the link.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(role, roleId, linkType=None, promotionType=None, createDateMax=None, advertiserId=None, pageToken=None, relationshipStatus=None, maxResults=None, authorship=None, startDateMin=None, assetSize=None, searchText=None, startDateMax=None, createDateMin=None)</code>
- <pre>Retrieves all links that match the query parameters.
-
-Args:
- role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
- Allowed values
- advertisers - The requester is requesting as an advertiser.
- publishers - The requester is requesting as a publisher.
- roleId: string, The ID of the requesting advertiser or publisher. (required)
- linkType: string, The type of the link.
- Allowed values
- banner -
- text -
- promotionType: string, The promotion type. (repeated)
- Allowed values
- coupon -
- free_gift -
- free_shipping -
- percent_off -
- price_cut -
- createDateMax: string, The end of the create date range.
- advertiserId: string, Limits the resulting links to the ones belonging to the listed advertisers. (repeated)
- pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
- relationshipStatus: string, The status of the relationship.
- Allowed values
- approved -
- available -
- maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.
- authorship: string, The role of the author of the link.
- Allowed values
- advertiser -
- publisher -
- startDateMin: string, The beginning of the start date range.
- assetSize: string, The size of the given asset. (repeated)
- searchText: string, Field for full text search across title and merchandising text, supports link id search.
- startDateMax: string, The end of the start date range.
- createDateMin: string, The beginning of the create date range.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The next page token.
- "items": [ # The links.
- { # A LinkResource.
- "isActive": True or False, # Flag for if this link is active.
- "linkType": "A String", # The link type.
- "kind": "gan#link", # The kind for one entity.
- "endDate": "A String", # Date that this link becomes inactive.
- "description": "A String", # Description.
- "name": "A String", # The logical name for this link.
- "specialOffers": { # Special offers on the link.
- "priceCut": { # An ApiMoneyProto. # Price cut on the purchase
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "priceCutMin": { # An ApiMoneyProto. # Minimum purchase amount for price cut promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeShipping": True or False, # Whether there is free shipping
- "promotionCodes": [ # List of promotion code associated with the link
- "A String",
- ],
- "percentOff": 3.14, # Percent off on the purchase
- "percentOffMin": { # An ApiMoneyProto. # Minimum purchase amount for percent off promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeGift": True or False, # Whether there is a free gift
- "freeShippingMin": { # An ApiMoneyProto. # Minimum purchase amount for free shipping promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- },
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "createDate": "A String", # Date that this link was created.
- "imageAltText": "A String", # image alt text.
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "advertiserId": "A String", # The advertiser id for the advertiser who owns this link.
- "id": "A String", # The ID of this link.
- "impressionTrackingUrl": "A String", # Tracking url for impressions.
- "promotionType": "A String", # Promotion Type
- "duration": "A String", # Duration
- "authorship": "A String", # Authorship
- "startDate": "A String", # Date that this link becomes active.
- "availability": "A String", # Availability.
- "clickTrackingUrl": "A String", # Tracking url for clicks.
- "destinationUrl": "A String", # The destination URL for the link.
- },
- ],
- "kind": "gan#links", # The kind for a page of links.
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/gan_v1beta1.publishers.html b/docs/dyn/gan_v1beta1.publishers.html
deleted file mode 100644
index 5d6a741..0000000
--- a/docs/dyn/gan_v1beta1.publishers.html
+++ /dev/null
@@ -1,195 +0,0 @@
-<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="gan_v1beta1.html">Google Affiliate Network API</a> . <a href="gan_v1beta1.publishers.html">publishers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(role, roleId, publisherId=None)</a></code></p>
-<p class="firstline">Retrieves data about a single advertiser if that the requesting advertiser/publisher has access to it. Only advertisers can look up publishers. Publishers can request information about themselves by omitting the publisherId query parameter.</p>
-<p class="toc_element">
- <code><a href="#list">list(role, roleId, publisherCategory=None, relationshipStatus=None, pageToken=None, minSevenDayEpc=None, minNinetyDayEpc=None, maxResults=None, minPayoutRank=None)</a></code></p>
-<p class="firstline">Retrieves data about all publishers that the requesting advertiser/publisher has access 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="get">get(role, roleId, publisherId=None)</code>
- <pre>Retrieves data about a single advertiser if that the requesting advertiser/publisher has access to it. Only advertisers can look up publishers. Publishers can request information about themselves by omitting the publisherId query parameter.
-
-Args:
- role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
- Allowed values
- advertisers - The requester is requesting as an advertiser.
- publishers - The requester is requesting as a publisher.
- roleId: string, The ID of the requesting advertiser or publisher. (required)
- publisherId: string, The ID of the publisher to look up. Optional.
-
-Returns:
- An object of the form:
-
- { # A PublisherResource.
- "status": "A String", # The status of the requesting advertiser's relationship with this publisher.
- "kind": "gan#publisher", # The kind for a publisher.
- "name": "A String", # The name of this publisher.
- "classification": "A String", # Classification that this publisher belongs to. See this link for all publisher classifications: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher divided by the total number of clicks over the past seven days. Values are multiplied by 100 for display purposes.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "payoutRank": "A String", # A rank based on commissions paid to this publisher over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid).
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher divided by the total number of clicks over the past three months. Values are multiplied by 100 for display purposes.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "item": # Object with schema name: Publisher # The requested publisher.
- "joinDate": "A String", # Date that this publisher was approved as a Google Affiliate Network publisher.
- "sites": [ # Websites that this publisher uses to advertise.
- "A String",
- ],
- "id": "A String", # The ID of this publisher.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(role, roleId, publisherCategory=None, relationshipStatus=None, pageToken=None, minSevenDayEpc=None, minNinetyDayEpc=None, maxResults=None, minPayoutRank=None)</code>
- <pre>Retrieves data about all publishers that the requesting advertiser/publisher has access to.
-
-Args:
- role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
- Allowed values
- advertisers - The requester is requesting as an advertiser.
- publishers - The requester is requesting as a publisher.
- roleId: string, The ID of the requesting advertiser or publisher. (required)
- publisherCategory: string, Caret(^) delimted list of publisher categories. Valid categories: (unclassified|community_and_content|shopping_and_promotion|loyalty_and_rewards|network|search_specialist|comparison_shopping|email). Filters out all publishers not in one of the given advertiser categories. Optional.
- relationshipStatus: string, Filters out all publishers for which do not have the given relationship status with the requesting publisher.
- Allowed values
- approved - Publishers you've approved to your program.
- available - Publishers available for you to recruit.
- deactivated - A publisher that you terminated from your program. Publishers also have the ability to remove themselves from your program.
- declined - A publisher that you did not approve to your program.
- pending - Publishers that have applied to your program. We recommend reviewing and deciding on pending publishers on a weekly basis.
- pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
- minSevenDayEpc: number, Filters out all publishers that have a seven day EPC average lower than the given value (inclusive). Min value 0.0. Optional.
- minNinetyDayEpc: number, Filters out all publishers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
- maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.
- minPayoutRank: integer, A value between 1 and 4, where 1 represents the quartile of publishers with the lowest ranks and 4 represents the quartile of publishers with the highest ranks. Filters out all publishers with a lower rank than the given quartile. For example if a 2 was given only publishers with a payout rank of 25 or higher would be included. Optional.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
- "items": [ # The entity list.
- { # A PublisherResource.
- "status": "A String", # The status of the requesting advertiser's relationship with this publisher.
- "kind": "gan#publisher", # The kind for a publisher.
- "name": "A String", # The name of this publisher.
- "classification": "A String", # Classification that this publisher belongs to. See this link for all publisher classifications: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher divided by the total number of clicks over the past seven days. Values are multiplied by 100 for display purposes.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "payoutRank": "A String", # A rank based on commissions paid to this publisher over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid).
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher divided by the total number of clicks over the past three months. Values are multiplied by 100 for display purposes.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "item": # Object with schema name: Publisher # The requested publisher.
- "joinDate": "A String", # Date that this publisher was approved as a Google Affiliate Network publisher.
- "sites": [ # Websites that this publisher uses to advertise.
- "A String",
- ],
- "id": "A String", # The ID of this publisher.
- },
- ],
- "kind": "gan#publishers", # The kind for a page of entities.
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/gan_v1beta1.reports.html b/docs/dyn/gan_v1beta1.reports.html
deleted file mode 100644
index 8c1d646..0000000
--- a/docs/dyn/gan_v1beta1.reports.html
+++ /dev/null
@@ -1,139 +0,0 @@
-<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="gan_v1beta1.html">Google Affiliate Network API</a> . <a href="gan_v1beta1.reports.html">reports</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(role, roleId, reportType, startDate=None, endDate=None, eventType=None, advertiserId=None, startIndex=None, calculateTotals=None, linkId=None, orderId=None, maxResults=None, status=None, publisherId=None)</a></code></p>
-<p class="firstline">Retrieves a report of the specified type.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(role, roleId, reportType, startDate=None, endDate=None, eventType=None, advertiserId=None, startIndex=None, calculateTotals=None, linkId=None, orderId=None, maxResults=None, status=None, publisherId=None)</code>
- <pre>Retrieves a report of the specified type.
-
-Args:
- role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
- Allowed values
- advertisers - The requester is requesting as an advertiser.
- publishers - The requester is requesting as a publisher.
- roleId: string, The ID of the requesting advertiser or publisher. (required)
- reportType: string, The type of report being requested. Valid values: 'order_delta'. Required. (required)
- Allowed values
- order_delta - The order delta report type.
- startDate: string, The start date (inclusive), in RFC 3339 format, for the report data to be returned. Defaults to one day before endDate, if that is given, or yesterday. Optional.
- endDate: string, The end date (exclusive), in RFC 3339 format, for the report data to be returned. Defaults to one day after startDate, if that is given, or today. Optional.
- eventType: string, Filters out all events that are not of the given type. Valid values: 'action', 'transaction', or 'charge'. Optional.
- Allowed values
- action - Event type is action.
- charge - Event type is charge.
- transaction - Event type is transaction.
- advertiserId: string, The IDs of the advertisers to look up, if applicable. (repeated)
- startIndex: integer, Offset on which to return results when paging. Optional.
- calculateTotals: boolean, Whether or not to calculate totals rows. Optional.
- linkId: string, Filters to capture one of given link IDs. Optional. (repeated)
- orderId: string, Filters to capture one of the given order IDs. Optional. (repeated)
- maxResults: integer, Max number of items to return in this page. Optional. Defaults to return all results.
- status: string, Filters out all events that do not have the given status. Valid values: 'active', 'canceled', or 'invalid'. Optional.
- Allowed values
- active - Event is currently active.
- canceled - Event is currently canceled.
- invalid - Event is currently invalid.
- publisherId: string, The IDs of the publishers to look up, if applicable. (repeated)
-
-Returns:
- An object of the form:
-
- { # A ReportResource representing a report of a certain type either for an advertiser or publisher.
- "totals_rows": [ # The totals rows for the report
- [ # Loop over each column in the row.
- "",
- ],
- ],
- "kind": "gan#report", # The kind for a report.
- "rows": [ # The rows of data for the report
- [ # Loop over each column in the row.
- "",
- ],
- ],
- "end_date": "A String", # The end of the date range for this report, exclusive.
- "matching_row_count": "A String", # The number of matching rows before paging is applied.
- "column_names": [ # The column names for the report
- "A String",
- ],
- "type": "A String", # The report type.
- "start_date": "A String", # The start of the date range for this report, inclusive.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/serviceregistry_alpha.html b/docs/dyn/genomics_v1alpha2.html
similarity index 86%
rename from docs/dyn/serviceregistry_alpha.html
rename to docs/dyn/genomics_v1alpha2.html
index fe160ea..6e1f388 100644
--- a/docs/dyn/serviceregistry_alpha.html
+++ b/docs/dyn/genomics_v1alpha2.html
@@ -72,19 +72,19 @@
</style>
-<h1><a href="serviceregistry_alpha.html">Google Cloud Service Registry API</a></h1>
+<h1><a href="genomics_v1alpha2.html">Genomics API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="serviceregistry_alpha.endpoints.html">endpoints()</a></code>
-</p>
-<p class="firstline">Returns the endpoints Resource.</p>
-
-<p class="toc_element">
- <code><a href="serviceregistry_alpha.operations.html">operations()</a></code>
+ <code><a href="genomics_v1alpha2.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
+ <code><a href="genomics_v1alpha2.pipelines.html">pipelines()</a></code>
+</p>
+<p class="firstline">Returns the pipelines Resource.</p>
+
+<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
<h3>Method Details</h3>
diff --git a/docs/dyn/genomics_v1alpha2.operations.html b/docs/dyn/genomics_v1alpha2.operations.html
new file mode 100644
index 0000000..39b7939
--- /dev/null
+++ b/docs/dyn/genomics_v1alpha2.operations.html
@@ -0,0 +1,197 @@
+<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="genomics_v1alpha2.html">Genomics API</a> . <a href="genomics_v1alpha2.operations.html">operations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#cancel">cancel(name, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.</p>
+<p class="toc_element">
+ <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists operations that match the specified filter in the request.</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="cancel">cancel(name, body, x__xgafv=None)</code>
+ <pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
+ "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists operations that match the specified filter in the request.
+
+Args:
+ name: string, The name of the operation collection. (required)
+ pageSize: integer, The maximum number of results to return. If unspecified, defaults to 256. The maximum value is 2048.
+ filter: string, A string for filtering Operations. The following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING`
+ pageToken: string, The standard list page token.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
+ "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "nextPageToken": "A String", # The standard List next-page token.
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1alpha2.pipelines.html b/docs/dyn/genomics_v1alpha2.pipelines.html
new file mode 100644
index 0000000..993c52b
--- /dev/null
+++ b/docs/dyn/genomics_v1alpha2.pipelines.html
@@ -0,0 +1,595 @@
+<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="genomics_v1alpha2.html">Genomics API</a> . <a href="genomics_v1alpha2.pipelines.html">pipelines</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than `pipelineId` populated, and then returns the same pipeline with `pipelineId` populated. This id can be used to run the pipeline. Caller must have WRITE permission to the project.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(pipelineId, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a pipeline based on ID. Caller must have WRITE permission to the project.</p>
+<p class="toc_element">
+ <code><a href="#get">get(pipelineId, x__xgafv=None)</a></code></p>
+<p class="firstline">Retrieves a pipeline based on ID. Caller must have READ permission to the project.</p>
+<p class="toc_element">
+ <code><a href="#getControllerConfig">getControllerConfig(validationToken=None, x__xgafv=None, operationId=None)</a></code></p>
+<p class="firstline">Gets controller configuration information. Should only be called by VMs created by the Pipelines Service and not by end users.</p>
+<p class="toc_element">
+ <code><a href="#list">list(pageSize=None, projectId=None, namePrefix=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists pipelines. Caller must have READ permission to the 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="#run">run(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Runs a pipeline. If `pipelineId` is specified in the request, then run a saved pipeline. If `ephemeralPipeline` is specified, then run that pipeline once without saving a copy. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used.</p>
+<p class="toc_element">
+ <code><a href="#setOperationStatus">setOperationStatus(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Sets status of a given operation. Any new timestamps (as determined by description) are appended to TimestampEvents. Should only be called by VMs created by the Pipelines Service and not by end users.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(body, x__xgafv=None)</code>
+ <pre>Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than `pipelineId` populated, and then returns the same pipeline with `pipelineId` populated. This id can be used to run the pipeline. Caller must have WRITE permission to the project.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.
+ "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
+ "name": "A String", # Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
+ "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have WRITE access.
+ "outputParameters": [ # Output parameters of the pipeline.
+ { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path filefile globdirectory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path filefile file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
+ "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
+ "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
+ "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
+ "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
+ },
+ "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
+ "description": "A String", # Human-readable description.
+ },
+ ],
+ "inputParameters": [ # Input parameters of the pipeline.
+ { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path filefile globdirectory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path filefile file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
+ "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
+ "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
+ "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
+ "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
+ },
+ "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
+ "description": "A String", # Human-readable description.
+ },
+ ],
+ "docker": { # The Docker execuctor specification. # Specifies the docker run information.
+ "cmd": "A String", # Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
+ "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
+ },
+ "resources": { # The system resources for the pipeline run. # Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
+ "noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. ** Note: To use this option, your project must be in Google Access for Private IPs Early Access Program.**
+ "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
+ "preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
+ "disks": [ # Disks to attach.
+ { # A Google Compute Engine disk resource specification.
+ "sizeGb": 42, # The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
+ "name": "A String", # Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
+ "autoDelete": True or False, # Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time.
+ "source": "A String", # The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
+ "readOnly": True or False, # Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
+ "mountPoint": "A String", # Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
+ "type": "A String", # Required. The type of the disk to create.
+ },
+ ],
+ "bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
+ "zones": [ # List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
+ "A String",
+ ],
+ "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
+ },
+ "description": "A String", # User-specified description.
+}
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.
+ "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
+ "name": "A String", # Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
+ "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have WRITE access.
+ "outputParameters": [ # Output parameters of the pipeline.
+ { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path filefile globdirectory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path filefile file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
+ "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
+ "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
+ "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
+ "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
+ },
+ "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
+ "description": "A String", # Human-readable description.
+ },
+ ],
+ "inputParameters": [ # Input parameters of the pipeline.
+ { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path filefile globdirectory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path filefile file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
+ "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
+ "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
+ "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
+ "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
+ },
+ "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
+ "description": "A String", # Human-readable description.
+ },
+ ],
+ "docker": { # The Docker execuctor specification. # Specifies the docker run information.
+ "cmd": "A String", # Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
+ "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
+ },
+ "resources": { # The system resources for the pipeline run. # Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
+ "noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. ** Note: To use this option, your project must be in Google Access for Private IPs Early Access Program.**
+ "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
+ "preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
+ "disks": [ # Disks to attach.
+ { # A Google Compute Engine disk resource specification.
+ "sizeGb": 42, # The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
+ "name": "A String", # Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
+ "autoDelete": True or False, # Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time.
+ "source": "A String", # The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
+ "readOnly": True or False, # Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
+ "mountPoint": "A String", # Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
+ "type": "A String", # Required. The type of the disk to create.
+ },
+ ],
+ "bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
+ "zones": [ # List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
+ "A String",
+ ],
+ "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
+ },
+ "description": "A String", # User-specified description.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(pipelineId, x__xgafv=None)</code>
+ <pre>Deletes a pipeline based on ID. Caller must have WRITE permission to the project.
+
+Args:
+ pipelineId: string, Caller must have WRITE access to the project in which this pipeline is defined. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(pipelineId, x__xgafv=None)</code>
+ <pre>Retrieves a pipeline based on ID. Caller must have READ permission to the project.
+
+Args:
+ pipelineId: string, Caller must have READ access to the project in which this pipeline is defined. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.
+ "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
+ "name": "A String", # Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
+ "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have WRITE access.
+ "outputParameters": [ # Output parameters of the pipeline.
+ { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path filefile globdirectory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path filefile file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
+ "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
+ "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
+ "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
+ "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
+ },
+ "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
+ "description": "A String", # Human-readable description.
+ },
+ ],
+ "inputParameters": [ # Input parameters of the pipeline.
+ { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path filefile globdirectory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path filefile file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
+ "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
+ "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
+ "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
+ "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
+ },
+ "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
+ "description": "A String", # Human-readable description.
+ },
+ ],
+ "docker": { # The Docker execuctor specification. # Specifies the docker run information.
+ "cmd": "A String", # Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
+ "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
+ },
+ "resources": { # The system resources for the pipeline run. # Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
+ "noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. ** Note: To use this option, your project must be in Google Access for Private IPs Early Access Program.**
+ "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
+ "preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
+ "disks": [ # Disks to attach.
+ { # A Google Compute Engine disk resource specification.
+ "sizeGb": 42, # The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
+ "name": "A String", # Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
+ "autoDelete": True or False, # Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time.
+ "source": "A String", # The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
+ "readOnly": True or False, # Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
+ "mountPoint": "A String", # Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
+ "type": "A String", # Required. The type of the disk to create.
+ },
+ ],
+ "bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
+ "zones": [ # List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
+ "A String",
+ ],
+ "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
+ },
+ "description": "A String", # User-specified description.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getControllerConfig">getControllerConfig(validationToken=None, x__xgafv=None, operationId=None)</code>
+ <pre>Gets controller configuration information. Should only be called by VMs created by the Pipelines Service and not by end users.
+
+Args:
+ validationToken: string, A parameter
+ x__xgafv: string, V1 error format.
+ operationId: string, The operation to retrieve controller configuration for.
+
+Returns:
+ An object of the form:
+
+ { # Stores the information that the controller will fetch from the server in order to run. Should only be used by VMs created by the Pipelines Service and not by end users.
+ "cmd": "A String",
+ "machineType": "A String",
+ "gcsLogPath": "A String",
+ "vars": {
+ "a_key": "A String",
+ },
+ "gcsSinks": {
+ "a_key": {
+ "values": [
+ "A String",
+ ],
+ },
+ },
+ "image": "A String",
+ "disks": {
+ "a_key": "A String",
+ },
+ "gcsSources": {
+ "a_key": {
+ "values": [
+ "A String",
+ ],
+ },
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(pageSize=None, projectId=None, namePrefix=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists pipelines. Caller must have READ permission to the project.
+
+Args:
+ pageSize: integer, Number of pipelines to return at once. Defaults to 256, and max is 2048.
+ projectId: string, Required. The name of the project to search for pipelines. Caller must have READ access to this project.
+ namePrefix: string, Pipelines with names that match this prefix should be returned. If unspecified, all pipelines in the project, up to `pageSize`, will be returned.
+ pageToken: string, Token to use to indicate where to start getting results. If unspecified, returns the first page of results.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # The response of ListPipelines. Contains at most `pageSize` pipelines. If it contains `pageSize` pipelines, and more pipelines exist, then `nextPageToken` will be populated and should be used as the `pageToken` argument to a subsequent ListPipelines request.
+ "nextPageToken": "A String", # The token to use to get the next page of results.
+ "pipelines": [ # The matched pipelines.
+ { # The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.
+ "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
+ "name": "A String", # Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
+ "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have WRITE access.
+ "outputParameters": [ # Output parameters of the pipeline.
+ { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path filefile globdirectory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path filefile file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
+ "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
+ "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
+ "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
+ "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
+ },
+ "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
+ "description": "A String", # Human-readable description.
+ },
+ ],
+ "inputParameters": [ # Input parameters of the pipeline.
+ { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path filefile globdirectory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path filefile file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
+ "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
+ "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
+ "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
+ "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
+ },
+ "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
+ "description": "A String", # Human-readable description.
+ },
+ ],
+ "docker": { # The Docker execuctor specification. # Specifies the docker run information.
+ "cmd": "A String", # Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
+ "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
+ },
+ "resources": { # The system resources for the pipeline run. # Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
+ "noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. ** Note: To use this option, your project must be in Google Access for Private IPs Early Access Program.**
+ "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
+ "preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
+ "disks": [ # Disks to attach.
+ { # A Google Compute Engine disk resource specification.
+ "sizeGb": 42, # The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
+ "name": "A String", # Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
+ "autoDelete": True or False, # Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time.
+ "source": "A String", # The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
+ "readOnly": True or False, # Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
+ "mountPoint": "A String", # Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
+ "type": "A String", # Required. The type of the disk to create.
+ },
+ ],
+ "bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
+ "zones": [ # List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
+ "A String",
+ ],
+ "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
+ },
+ "description": "A String", # User-specified description.
+ },
+ ],
+ }</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="run">run(body, x__xgafv=None)</code>
+ <pre>Runs a pipeline. If `pipelineId` is specified in the request, then run a saved pipeline. If `ephemeralPipeline` is specified, then run that pipeline once without saving a copy. The caller must have READ permission to the project where the pipeline is stored and WRITE permission to the project where the pipeline will be run, as VMs will be created and storage will be used.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request to run a pipeline. If `pipelineId` is specified, it refers to a saved pipeline created with CreatePipeline and set as the `pipelineId` of the returned Pipeline object. If `ephemeralPipeline` is specified, that pipeline is run once with the given args and not saved. It is an error to specify both `pipelineId` and `ephemeralPipeline`. `pipelineArgs` must be specified.
+ "pipelineArgs": { # The pipeline run arguments. # The arguments to use when running this pipeline.
+ "inputs": { # Pipeline input arguments; keys are defined in the pipeline documentation. All input parameters that do not have default values must be specified. If parameters with defaults are specified here, the defaults will be overridden.
+ "a_key": "A String",
+ },
+ "logging": { # The logging options for the pipeline run. # Required. Logging options. Used by the service to communicate results to the user.
+ "gcsPath": "A String", # The location in Google Cloud Storage to which the pipeline logs will be copied. Can be specified as a fully qualified directory path, in which case logs will be output with a unique identifier as the filename in that directory, or as a fully specified path, which must end in `.log`, in which case that path will be used, and the user must ensure that logs are not overwritten. Stdout and stderr logs from the run are also generated and output as `-stdout.log` and `-stderr.log`.
+ },
+ "projectId": "A String", # Required. The project in which to run the pipeline. The caller must have WRITER access to all Google Cloud services and resources (e.g. Google Compute Engine) will be used.
+ "serviceAccount": { # A Google Cloud Service Account. # The Google Cloud Service Account that will be used to access data and services. By default, the compute service account associated with `projectId` is used.
+ "scopes": [ # List of scopes to be enabled for this service account on the VM. The following scopes are automatically included: * https://www.googleapis.com/auth/compute * https://www.googleapis.com/auth/devstorage.full_control * https://www.googleapis.com/auth/genomics * https://www.googleapis.com/auth/logging.write * https://www.googleapis.com/auth/monitoring.write
+ "A String",
+ ],
+ "email": "A String", # Email address of the service account. Defaults to `default`, which uses the compute service account associated with the project.
+ },
+ "clientId": "A String", # Client-specified pipeline operation identifier.
+ "outputs": { # Pipeline output arguments; keys are defined in the pipeline documentation. All output parameters of without default values must be specified. If parameters with defaults are specified here, the defaults will be overridden.
+ "a_key": "A String",
+ },
+ "keepVmAliveOnFailureDuration": "A String", # How long to keep the VM up after a failure (for example docker command failed, copying input or output files failed, etc). While the VM is up, one can ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.
+ "resources": { # The system resources for the pipeline run. # Specifies resource requirements/overrides for the pipeline run.
+ "noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. ** Note: To use this option, your project must be in Google Access for Private IPs Early Access Program.**
+ "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
+ "preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
+ "disks": [ # Disks to attach.
+ { # A Google Compute Engine disk resource specification.
+ "sizeGb": 42, # The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
+ "name": "A String", # Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
+ "autoDelete": True or False, # Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time.
+ "source": "A String", # The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
+ "readOnly": True or False, # Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
+ "mountPoint": "A String", # Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
+ "type": "A String", # Required. The type of the disk to create.
+ },
+ ],
+ "bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
+ "zones": [ # List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
+ "A String",
+ ],
+ "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
+ },
+ },
+ "ephemeralPipeline": { # The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method. # A new pipeline object to run once and then delete.
+ "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
+ "name": "A String", # Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
+ "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have WRITE access.
+ "outputParameters": [ # Output parameters of the pipeline.
+ { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path filefile globdirectory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path filefile file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
+ "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
+ "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
+ "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
+ "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
+ },
+ "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
+ "description": "A String", # Human-readable description.
+ },
+ ],
+ "inputParameters": [ # Input parameters of the pipeline.
+ { # Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ``` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} ``` where `disk` is defined in the `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} ``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path filefile globdirectory For outputs, the direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path filefile file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.
+ "defaultValue": "A String", # The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
+ "localCopy": { # LocalCopy defines how a remote file should be copied to and from the VM. # If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
+ "path": "A String", # Required. The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
+ "disk": "A String", # Required. The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
+ },
+ "name": "A String", # Required. Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
+ "description": "A String", # Human-readable description.
+ },
+ ],
+ "docker": { # The Docker execuctor specification. # Specifies the docker run information.
+ "cmd": "A String", # Required. The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
+ "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
+ },
+ "resources": { # The system resources for the pipeline run. # Required. Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
+ "noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. ** Note: To use this option, your project must be in Google Access for Private IPs Early Access Program.**
+ "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
+ "preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
+ "disks": [ # Disks to attach.
+ { # A Google Compute Engine disk resource specification.
+ "sizeGb": 42, # The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
+ "name": "A String", # Required. The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
+ "autoDelete": True or False, # Specifies whether or not to delete the disk when the pipeline completes. This field is applicable only for newly created disks. See https://cloud.google.com/compute/docs/reference/latest/instances#resource for more details. By default, `autoDelete` is `false`. `autoDelete` will be enabled if set to `true` at create time or run time.
+ "source": "A String", # The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
+ "readOnly": True or False, # Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
+ "mountPoint": "A String", # Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
+ "type": "A String", # Required. The type of the disk to create.
+ },
+ ],
+ "bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
+ "zones": [ # List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
+ "A String",
+ ],
+ "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
+ },
+ "description": "A String", # User-specified description.
+ },
+ "pipelineId": "A String", # The already created pipeline to run.
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
+ "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setOperationStatus">setOperationStatus(body, x__xgafv=None)</code>
+ <pre>Sets status of a given operation. Any new timestamps (as determined by description) are appended to TimestampEvents. Should only be called by VMs created by the Pipelines Service and not by end users.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request to set operation status. Should only be used by VMs created by the Pipelines Service and not by end users.
+ "errorCode": "A String",
+ "errorMessage": "A String",
+ "timestampEvents": [
+ { # Stores the list of events and times they occured for major events in job execution.
+ "timestamp": "A String", # The time this event occured.
+ "description": "A String", # String indicating the type of event
+ },
+ ],
+ "validationToken": "A String",
+ "operationId": "A String",
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1beta.beacons.html b/docs/dyn/genomics_v1beta.beacons.html
deleted file mode 100644
index 7138c3f..0000000
--- a/docs/dyn/genomics_v1beta.beacons.html
+++ /dev/null
@@ -1,99 +0,0 @@
-<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="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.beacons.html">beacons</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(variantSetId, allele=None, referenceName=None, position=None)</a></code></p>
-<p class="firstline">This is an experimental API that provides a Global Alliance for Genomics and Health Beacon. It may change at any time.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(variantSetId, allele=None, referenceName=None, position=None)</code>
- <pre>This is an experimental API that provides a Global Alliance for Genomics and Health Beacon. It may change at any time.
-
-Args:
- variantSetId: string, The ID of the variant set to query over. It must be public. Private variant sets will return an unauthorized exception. (required)
- allele: string, Required. The allele to look for ('A', 'C', 'G' or 'T').
- referenceName: string, Required. The reference to query over.
- position: string, Required. The 0-based position to query.
-
-Returns:
- An object of the form:
-
- { # A beacon represents whether any variant call in a variant set has a specific allele at a particular position.
- "exists": True or False, # True if the allele exists on any variant call, false otherwise.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1beta.callsets.html b/docs/dyn/genomics_v1beta.callsets.html
deleted file mode 100644
index 0061a4c..0000000
--- a/docs/dyn/genomics_v1beta.callsets.html
+++ /dev/null
@@ -1,304 +0,0 @@
-<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="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.callsets.html">callsets</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#create">create(body)</a></code></p>
-<p class="firstline">Creates a new call set.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(callSetId)</a></code></p>
-<p class="firstline">Deletes a call set.</p>
-<p class="toc_element">
- <code><a href="#get">get(callSetId)</a></code></p>
-<p class="firstline">Gets a call set by ID.</p>
-<p class="toc_element">
- <code><a href="#patch">patch(callSetId, body)</a></code></p>
-<p class="firstline">Updates a call set. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#search">search(body)</a></code></p>
-<p class="firstline">Gets a list of call sets matching the criteria.</p>
-<p class="toc_element">
- <code><a href="#update">update(callSetId, body)</a></code></p>
-<p class="firstline">Updates a call set.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(body)</code>
- <pre>Creates a new call set.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A CallSet is a collection of variant calls. It belongs to a variant set.
- "info": { # A map of additional callset information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "name": "A String", # The callset name.
- "created": "A String", # The date this call set was created in milliseconds from the epoch.
- "sampleId": "A String", # The sample ID this call set corresponds to.
- "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
- "A String",
- ],
- "id": "A String", # The Google generated ID of the call set, immutable.
-}
-
-
-Returns:
- An object of the form:
-
- { # A CallSet is a collection of variant calls. It belongs to a variant set.
- "info": { # A map of additional callset information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "name": "A String", # The callset name.
- "created": "A String", # The date this call set was created in milliseconds from the epoch.
- "sampleId": "A String", # The sample ID this call set corresponds to.
- "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
- "A String",
- ],
- "id": "A String", # The Google generated ID of the call set, immutable.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(callSetId)</code>
- <pre>Deletes a call set.
-
-Args:
- callSetId: string, The ID of the callset to be deleted. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(callSetId)</code>
- <pre>Gets a call set by ID.
-
-Args:
- callSetId: string, The ID of the callset. (required)
-
-Returns:
- An object of the form:
-
- { # A CallSet is a collection of variant calls. It belongs to a variant set.
- "info": { # A map of additional callset information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "name": "A String", # The callset name.
- "created": "A String", # The date this call set was created in milliseconds from the epoch.
- "sampleId": "A String", # The sample ID this call set corresponds to.
- "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
- "A String",
- ],
- "id": "A String", # The Google generated ID of the call set, immutable.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(callSetId, body)</code>
- <pre>Updates a call set. This method supports patch semantics.
-
-Args:
- callSetId: string, The ID of the callset to be updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A CallSet is a collection of variant calls. It belongs to a variant set.
- "info": { # A map of additional callset information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "name": "A String", # The callset name.
- "created": "A String", # The date this call set was created in milliseconds from the epoch.
- "sampleId": "A String", # The sample ID this call set corresponds to.
- "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
- "A String",
- ],
- "id": "A String", # The Google generated ID of the call set, immutable.
-}
-
-
-Returns:
- An object of the form:
-
- { # A CallSet is a collection of variant calls. It belongs to a variant set.
- "info": { # A map of additional callset information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "name": "A String", # The callset name.
- "created": "A String", # The date this call set was created in milliseconds from the epoch.
- "sampleId": "A String", # The sample ID this call set corresponds to.
- "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
- "A String",
- ],
- "id": "A String", # The Google generated ID of the call set, immutable.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="search">search(body)</code>
- <pre>Gets a list of call sets matching the criteria.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The call set search request.
- "pageToken": "A String", # The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- "variantSetIds": [ # Restrict the query to call sets within the given variant sets. At least one ID must be provided.
- "A String",
- ],
- "name": "A String", # Only return call sets for which a substring of the name matches this string.
- "pageSize": 42, # The maximum number of call sets to return.
- }
-
-
-Returns:
- An object of the form:
-
- { # The call set search response.
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
- "callSets": [ # The list of matching call sets.
- { # A CallSet is a collection of variant calls. It belongs to a variant set.
- "info": { # A map of additional callset information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "name": "A String", # The callset name.
- "created": "A String", # The date this call set was created in milliseconds from the epoch.
- "sampleId": "A String", # The sample ID this call set corresponds to.
- "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
- "A String",
- ],
- "id": "A String", # The Google generated ID of the call set, immutable.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(callSetId, body)</code>
- <pre>Updates a call set.
-
-Args:
- callSetId: string, The ID of the callset to be updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A CallSet is a collection of variant calls. It belongs to a variant set.
- "info": { # A map of additional callset information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "name": "A String", # The callset name.
- "created": "A String", # The date this call set was created in milliseconds from the epoch.
- "sampleId": "A String", # The sample ID this call set corresponds to.
- "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
- "A String",
- ],
- "id": "A String", # The Google generated ID of the call set, immutable.
-}
-
-
-Returns:
- An object of the form:
-
- { # A CallSet is a collection of variant calls. It belongs to a variant set.
- "info": { # A map of additional callset information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "name": "A String", # The callset name.
- "created": "A String", # The date this call set was created in milliseconds from the epoch.
- "sampleId": "A String", # The sample ID this call set corresponds to.
- "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
- "A String",
- ],
- "id": "A String", # The Google generated ID of the call set, immutable.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1beta.datasets.html b/docs/dyn/genomics_v1beta.datasets.html
deleted file mode 100644
index 7ab7897..0000000
--- a/docs/dyn/genomics_v1beta.datasets.html
+++ /dev/null
@@ -1,269 +0,0 @@
-<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="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.datasets.html">datasets</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#create">create(body)</a></code></p>
-<p class="firstline">Creates a new dataset.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(datasetId)</a></code></p>
-<p class="firstline">Deletes a dataset.</p>
-<p class="toc_element">
- <code><a href="#get">get(datasetId)</a></code></p>
-<p class="firstline">Gets a dataset by ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(pageToken=None, maxResults=None, projectId=None)</a></code></p>
-<p class="firstline">Lists all datasets.</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(datasetId, body)</a></code></p>
-<p class="firstline">Updates a dataset. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#undelete">undelete(datasetId)</a></code></p>
-<p class="firstline">Undeletes a dataset by restoring a dataset which was deleted via this API. This operation is only possible for a week after the deletion occurred.</p>
-<p class="toc_element">
- <code><a href="#update">update(datasetId, body)</a></code></p>
-<p class="firstline">Updates a dataset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(body)</code>
- <pre>Creates a new dataset.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Dataset is a collection of genomic data.
- "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
- "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
- "id": "A String", # The Google generated ID of the dataset, immutable.
- "name": "A String", # The dataset name.
-}
-
-
-Returns:
- An object of the form:
-
- { # A Dataset is a collection of genomic data.
- "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
- "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
- "id": "A String", # The Google generated ID of the dataset, immutable.
- "name": "A String", # The dataset name.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(datasetId)</code>
- <pre>Deletes a dataset.
-
-Args:
- datasetId: string, The ID of the dataset to be deleted. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(datasetId)</code>
- <pre>Gets a dataset by ID.
-
-Args:
- datasetId: string, The ID of the dataset. (required)
-
-Returns:
- An object of the form:
-
- { # A Dataset is a collection of genomic data.
- "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
- "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
- "id": "A String", # The Google generated ID of the dataset, immutable.
- "name": "A String", # The dataset name.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(pageToken=None, maxResults=None, projectId=None)</code>
- <pre>Lists all datasets.
-
-Args:
- pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- maxResults: string, The maximum number of results returned by this request.
- projectId: string, Only return datasets which belong to this Google Developers Console project. Only accepts project numbers. Returns all public projects if no project number is specified.
-
-Returns:
- An object of the form:
-
- { # The dataset list response.
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
- "datasets": [ # The list of matching Datasets.
- { # A Dataset is a collection of genomic data.
- "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
- "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
- "id": "A String", # The Google generated ID of the dataset, immutable.
- "name": "A String", # The dataset name.
- },
- ],
- }</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(datasetId, body)</code>
- <pre>Updates a dataset. This method supports patch semantics.
-
-Args:
- datasetId: string, The ID of the dataset to be updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Dataset is a collection of genomic data.
- "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
- "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
- "id": "A String", # The Google generated ID of the dataset, immutable.
- "name": "A String", # The dataset name.
-}
-
-
-Returns:
- An object of the form:
-
- { # A Dataset is a collection of genomic data.
- "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
- "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
- "id": "A String", # The Google generated ID of the dataset, immutable.
- "name": "A String", # The dataset name.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="undelete">undelete(datasetId)</code>
- <pre>Undeletes a dataset by restoring a dataset which was deleted via this API. This operation is only possible for a week after the deletion occurred.
-
-Args:
- datasetId: string, The ID of the dataset to be undeleted. (required)
-
-Returns:
- An object of the form:
-
- { # A Dataset is a collection of genomic data.
- "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
- "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
- "id": "A String", # The Google generated ID of the dataset, immutable.
- "name": "A String", # The dataset name.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(datasetId, body)</code>
- <pre>Updates a dataset.
-
-Args:
- datasetId: string, The ID of the dataset to be updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Dataset is a collection of genomic data.
- "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
- "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
- "id": "A String", # The Google generated ID of the dataset, immutable.
- "name": "A String", # The dataset name.
-}
-
-
-Returns:
- An object of the form:
-
- { # A Dataset is a collection of genomic data.
- "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
- "isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
- "id": "A String", # The Google generated ID of the dataset, immutable.
- "name": "A String", # The dataset name.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1beta.experimental.html b/docs/dyn/genomics_v1beta.experimental.html
deleted file mode 100644
index 25f4499..0000000
--- a/docs/dyn/genomics_v1beta.experimental.html
+++ /dev/null
@@ -1,82 +0,0 @@
-<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="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.experimental.html">experimental</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="genomics_v1beta.experimental.jobs.html">jobs()</a></code>
-</p>
-<p class="firstline">Returns the jobs Resource.</p>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1beta.experimental.jobs.html b/docs/dyn/genomics_v1beta.experimental.jobs.html
deleted file mode 100644
index bcfb897..0000000
--- a/docs/dyn/genomics_v1beta.experimental.jobs.html
+++ /dev/null
@@ -1,111 +0,0 @@
-<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="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.experimental.html">experimental</a> . <a href="genomics_v1beta.experimental.jobs.html">jobs</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#create">create(body)</a></code></p>
-<p class="firstline">Creates and asynchronously runs an ad-hoc job. This is an experimental call and may be removed or changed at any time.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(body)</code>
- <pre>Creates and asynchronously runs an ad-hoc job. This is an experimental call and may be removed or changed at any time.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The job creation request.
- "pairedSourceUris": [ # A list of Google Cloud Storage URIs of paired end .fastq files to operate upon. If specified, this represents the second file of each paired .fastq file. The first file of each pair should be specified in sourceUris.
- "A String",
- ],
- "projectId": "A String", # Required. The Google Cloud Project ID with which to associate the request.
- "align": True or False, # Specifies whether or not to run the alignment pipeline. At least one of align or callVariants must be provided.
- "callVariants": True or False, # Specifies whether or not to run the variant calling pipeline. If specified, alignment will be performed first and the aligned BAMs will passed as input to the variant caller. At least one of align or callVariants must be provided.
- "sourceUris": [ # A list of Google Cloud Storage URIs of data files to operate upon. These can be .bam, interleaved .fastq, or paired .fastq. If specifying paired .fastq files, the first of each pair of files should be listed here, and the second of each pair should be listed in pairedSourceUris.
- "A String",
- ],
- "gcsOutputPath": "A String", # Specifies where to copy the results of certain pipelines. This should be in the form of gs://bucket/path.
- }
-
-
-Returns:
- An object of the form:
-
- { # The job creation response.
- "jobId": "A String", # A job ID that can be used to get status information.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1beta.html b/docs/dyn/genomics_v1beta.html
deleted file mode 100644
index 3832845..0000000
--- a/docs/dyn/genomics_v1beta.html
+++ /dev/null
@@ -1,122 +0,0 @@
-<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="genomics_v1beta.html">Genomics API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="genomics_v1beta.beacons.html">beacons()</a></code>
-</p>
-<p class="firstline">Returns the beacons Resource.</p>
-
-<p class="toc_element">
- <code><a href="genomics_v1beta.callsets.html">callsets()</a></code>
-</p>
-<p class="firstline">Returns the callsets Resource.</p>
-
-<p class="toc_element">
- <code><a href="genomics_v1beta.datasets.html">datasets()</a></code>
-</p>
-<p class="firstline">Returns the datasets Resource.</p>
-
-<p class="toc_element">
- <code><a href="genomics_v1beta.experimental.html">experimental()</a></code>
-</p>
-<p class="firstline">Returns the experimental Resource.</p>
-
-<p class="toc_element">
- <code><a href="genomics_v1beta.jobs.html">jobs()</a></code>
-</p>
-<p class="firstline">Returns the jobs Resource.</p>
-
-<p class="toc_element">
- <code><a href="genomics_v1beta.reads.html">reads()</a></code>
-</p>
-<p class="firstline">Returns the reads Resource.</p>
-
-<p class="toc_element">
- <code><a href="genomics_v1beta.readsets.html">readsets()</a></code>
-</p>
-<p class="firstline">Returns the readsets Resource.</p>
-
-<p class="toc_element">
- <code><a href="genomics_v1beta.variants.html">variants()</a></code>
-</p>
-<p class="firstline">Returns the variants Resource.</p>
-
-<p class="toc_element">
- <code><a href="genomics_v1beta.variantsets.html">variantsets()</a></code>
-</p>
-<p class="firstline">Returns the variantsets Resource.</p>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1beta.jobs.html b/docs/dyn/genomics_v1beta.jobs.html
deleted file mode 100644
index 72faea4..0000000
--- a/docs/dyn/genomics_v1beta.jobs.html
+++ /dev/null
@@ -1,188 +0,0 @@
-<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="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.jobs.html">jobs</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#cancel">cancel(jobId)</a></code></p>
-<p class="firstline">Cancels a job by ID. Note that it is possible for partial results to be generated and stored for cancelled jobs.</p>
-<p class="toc_element">
- <code><a href="#get">get(jobId)</a></code></p>
-<p class="firstline">Gets a job by ID.</p>
-<p class="toc_element">
- <code><a href="#search">search(body)</a></code></p>
-<p class="firstline">Gets a list of jobs matching the criteria.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="cancel">cancel(jobId)</code>
- <pre>Cancels a job by ID. Note that it is possible for partial results to be generated and stored for cancelled jobs.
-
-Args:
- jobId: string, Required. The ID of the job. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(jobId)</code>
- <pre>Gets a job by ID.
-
-Args:
- jobId: string, Required. The ID of the job. (required)
-
-Returns:
- An object of the form:
-
- { # A Job represents an ongoing process that can be monitored for status information.
- "status": "A String", # The status of this job.
- "errors": [ # Any errors that occurred during processing.
- "A String",
- ],
- "description": "A String", # A more detailed description of this job's current status.
- "created": "A String", # The date this job was created, in milliseconds from the epoch.
- "projectId": "A String", # The Google Developers Console project number to which this job belongs.
- "warnings": [ # Any warnings that occurred during processing.
- "A String",
- ],
- "request": { # A summary representation of the service request that spawned the job. # A summarized representation of the original service request.
- "source": [ # The data source of the request, for example, a Google Cloud Storage object path or Readset ID.
- "A String",
- ],
- "destination": [ # The data destination of the request, for example, a Google BigQuery Table or Dataset ID.
- "A String",
- ],
- "type": "A String", # The original request type.
- },
- "importedIds": [ # If this Job represents an import, this field will contain the IDs of the objects that were successfully imported.
- "A String",
- ],
- "id": "A String", # The job ID.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="search">search(body)</code>
- <pre>Gets a list of jobs matching the criteria.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The jobs search request.
- "status": [ # Only return jobs which have a matching status.
- "A String",
- ],
- "createdAfter": "A String", # If specified, only jobs created on or after this date, given in milliseconds since Unix epoch, will be returned.
- "projectId": "A String", # Required. Only return jobs which belong to this Google Developers
- "maxResults": "A String", # Specifies the number of results to return in a single page. Defaults to 128. The maximum value is 256.
- "pageToken": "A String", # The continuation token which is used to page through large result sets. To get the next page of results, set this parameter to the value of the nextPageToken from the previous response.
- "createdBefore": "A String", # If specified, only jobs created prior to this date, given in milliseconds since Unix epoch, will be returned.
- }
-
-
-Returns:
- An object of the form:
-
- { # The job search response.
- "nextPageToken": "A String", # The continuation token which is used to page through large result sets. Provide this value is a subsequent request to return the next page of results. This field will be empty if there are no more results.
- "jobs": [ # The list of jobs results, ordered newest to oldest.
- { # A Job represents an ongoing process that can be monitored for status information.
- "status": "A String", # The status of this job.
- "errors": [ # Any errors that occurred during processing.
- "A String",
- ],
- "description": "A String", # A more detailed description of this job's current status.
- "created": "A String", # The date this job was created, in milliseconds from the epoch.
- "projectId": "A String", # The Google Developers Console project number to which this job belongs.
- "warnings": [ # Any warnings that occurred during processing.
- "A String",
- ],
- "request": { # A summary representation of the service request that spawned the job. # A summarized representation of the original service request.
- "source": [ # The data source of the request, for example, a Google Cloud Storage object path or Readset ID.
- "A String",
- ],
- "destination": [ # The data destination of the request, for example, a Google BigQuery Table or Dataset ID.
- "A String",
- ],
- "type": "A String", # The original request type.
- },
- "importedIds": [ # If this Job represents an import, this field will contain the IDs of the objects that were successfully imported.
- "A String",
- ],
- "id": "A String", # The job ID.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1beta.reads.html b/docs/dyn/genomics_v1beta.reads.html
deleted file mode 100644
index 1d45e8e..0000000
--- a/docs/dyn/genomics_v1beta.reads.html
+++ /dev/null
@@ -1,132 +0,0 @@
-<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="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.reads.html">reads</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#search">search(body)</a></code></p>
-<p class="firstline">Gets a list of reads for one or more readsets. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested readsets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only readset IDs yields all reads in those readsets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (reference sequence & position). Reads with equivalent genomic coordinates are returned in a deterministic order.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="search">search(body)</code>
- <pre>Gets a list of reads for one or more readsets. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested readsets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only readset IDs yields all reads in those readsets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (reference sequence & position). Reads with equivalent genomic coordinates are returned in a deterministic order.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The read search request.
- "sequenceStart": "A String", # The start position (1-based, inclusive) of the target range. If specified, sequenceName must also be specified. Defaults to the start of the target reference sequence, if any.
- "readsetIds": [ # The readsets within which to search for reads. At least one readset ID must be provided. All specified readsets must be aligned against a common set of reference sequences; this defines the genomic coordinates for the query.
- "A String",
- ],
- "sequenceEnd": "A String", # The end position (1-based, inclusive) of the target range. If specified, sequenceName must also be specified. Defaults to the end of the target reference sequence, if any.
- "maxResults": "A String", # Specifies number of results to return in a single page. If unspecified, it will default to 256. The maximum value is 2048.
- "pageToken": "A String", # The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- "sequenceName": "A String", # Restricts the results to a particular reference sequence such as 1, chr1, or X. The set of valid references sequences depends on the readsets specified. If set to *, only unmapped Reads are returned.
- }
-
-
-Returns:
- An object of the form:
-
- { # The read search response.
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
- "reads": [ # The list of matching Reads. The resulting Reads are sorted by position; the smallest positions are returned first. Unmapped reads, which have no position, are returned last and are further sorted alphabetically by name.
- { # A Read is a group of bases that may or may not have been aligned to a reference. It contains quality information and other metadata.
- "mateReferenceSequenceName": "A String", # The name of the sequence that the paired read is aligned to. This is usually the same as referenceSequenceName. (RNEXT)
- "referenceSequenceName": "A String", # The name of the sequence that this read is aligned to. This would be, for example, 'X' for the X Chromosome or '20' for Chromosome 20. (RNAME)
- "name": "A String", # The name of the read. When imported from a BAM file, this is the query template name. (QNAME)
- "mappingQuality": 42, # A score up to 255 that represents how likely this read's aligned position is to be correct. A higher value is better. (MAPQ)
- "templateLength": 42, # Length of the original piece of DNA that produced both this read and the paired read. (TLEN)
- "cigar": "A String", # A condensed representation of how this read matches up to the reference. (CIGAR)
- "readsetId": "A String", # The ID of the readset this read belongs to.
- "matePosition": 42, # The 1-based start position of the paired read. (PNEXT)
- "tags": { # A map of additional read information. (TAG)
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "flags": 42, # Each bit of this number has a different meaning if enabled. See the full BAM spec for more details. (FLAG)
- "position": 42, # The 1-based start position of the aligned read. If the first base starts at the very beginning of the reference sequence, then the position would be '1'. (POS)
- "baseQuality": "A String", # Represents the quality of each base in this read. Each character represents one base. To get the quality, take the ASCII value of the character and subtract 33. (QUAL)
- "originalBases": "A String", # The list of bases that this read represents (such as "CATCGA"). (SEQ)
- "id": "A String", # The Google generated ID of the read, immutable.
- "alignedBases": "A String", # The originalBases after the cigar field has been applied. Deletions are represented with '-' and insertions are omitted.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1beta.readsets.coveragebuckets.html b/docs/dyn/genomics_v1beta.readsets.coveragebuckets.html
deleted file mode 100644
index d182b35..0000000
--- a/docs/dyn/genomics_v1beta.readsets.coveragebuckets.html
+++ /dev/null
@@ -1,130 +0,0 @@
-<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="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.readsets.html">readsets</a> . <a href="genomics_v1beta.readsets.coveragebuckets.html">coveragebuckets</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(readsetId, range_sequenceName=None, pageToken=None, range_sequenceEnd=None, maxResults=None, range_sequenceStart=None, targetBucketWidth=None)</a></code></p>
-<p class="firstline">Lists fixed width coverage buckets for a readset, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at various bucket widths, enabling various coverage "zoom levels". The caller must have READ permissions for the target readset.</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(readsetId, range_sequenceName=None, pageToken=None, range_sequenceEnd=None, maxResults=None, range_sequenceStart=None, targetBucketWidth=None)</code>
- <pre>Lists fixed width coverage buckets for a readset, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at various bucket widths, enabling various coverage "zoom levels". The caller must have READ permissions for the target readset.
-
-Args:
- readsetId: string, Required. The ID of the readset over which coverage is requested. (required)
- range_sequenceName: string, The reference sequence name, for example chr1, 1, or chrX.
- pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- range_sequenceEnd: string, The end position of the range on the reference, 1-based exclusive. If specified, sequenceName must also be specified.
- maxResults: string, The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 2048.
- range_sequenceStart: string, The start position of the range on the reference, 1-based inclusive. If specified, sequenceName must also be specified.
- targetBucketWidth: string, The desired width of each reported coverage bucket in base pairs. This will be rounded down to the nearest precomputed bucket width; the value of which is returned as bucketWidth in the response. Defaults to infinity (each bucket spans an entire reference sequence) or the length of the target range, if specified. The smallest precomputed bucketWidth is currently 2048 base pairs; this is subject to change.
-
-Returns:
- An object of the form:
-
- {
- "coverageBuckets": [ # The coverage buckets. The list of buckets is sparse; a bucket with 0 overlapping reads is not returned. A bucket never crosses more than one reference sequence. Each bucket has width bucketWidth, unless its end is the end of the reference sequence.
- { # A bucket over which read coverage has been precomputed. A bucket corresponds to a specific range of the reference sequence.
- "meanCoverage": 3.14, # The average number of reads which are aligned to each individual reference base in this bucket.
- "range": { # An inclusive, exclusive genomic coordinate range over a reference sequence. # The genomic coordinate range spanned by this bucket.
- "sequenceStart": "A String", # The start position of the range on the reference, 1-based inclusive. If specified, sequenceName must also be specified.
- "sequenceEnd": "A String", # The end position of the range on the reference, 1-based exclusive. If specified, sequenceName must also be specified.
- "sequenceName": "A String", # The reference sequence name, for example chr1, 1, or chrX.
- },
- },
- ],
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
- "bucketWidth": "A String", # The length of each coverage bucket in base pairs. Note that buckets at the end of a reference sequence may be shorter. This value is omitted if the bucket width is infinity (the default behaviour, with no range or targetBucketWidth).
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1beta.readsets.html b/docs/dyn/genomics_v1beta.readsets.html
deleted file mode 100644
index ed2facb..0000000
--- a/docs/dyn/genomics_v1beta.readsets.html
+++ /dev/null
@@ -1,567 +0,0 @@
-<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="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.readsets.html">readsets</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="genomics_v1beta.readsets.coveragebuckets.html">coveragebuckets()</a></code>
-</p>
-<p class="firstline">Returns the coveragebuckets Resource.</p>
-
-<p class="toc_element">
- <code><a href="#delete">delete(readsetId)</a></code></p>
-<p class="firstline">Deletes a readset.</p>
-<p class="toc_element">
- <code><a href="#export">export(body)</a></code></p>
-<p class="firstline">Exports readsets to a BAM file in Google Cloud Storage. Note that currently there may be some differences between exported BAM files and the original BAM file at the time of import. In particular, comments in the input file header will not be preserved, and some custom tags will be converted to strings.</p>
-<p class="toc_element">
- <code><a href="#get">get(readsetId)</a></code></p>
-<p class="firstline">Gets a readset by ID.</p>
-<p class="toc_element">
- <code><a href="#import_">import_(body)</a></code></p>
-<p class="firstline">Creates readsets by asynchronously importing the provided information. Note that currently comments in the input file header are not imported and some custom tags will be converted to strings, rather than preserving tag types. The caller must have WRITE permissions to the dataset.</p>
-<p class="toc_element">
- <code><a href="#patch">patch(readsetId, body)</a></code></p>
-<p class="firstline">Updates a readset. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#search">search(body)</a></code></p>
-<p class="firstline">Gets a list of readsets matching the criteria.</p>
-<p class="toc_element">
- <code><a href="#update">update(readsetId, body)</a></code></p>
-<p class="firstline">Updates a readset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(readsetId)</code>
- <pre>Deletes a readset.
-
-Args:
- readsetId: string, The ID of the readset to be deleted. The caller must have WRITE permissions to the dataset associated with this readset. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="export">export(body)</code>
- <pre>Exports readsets to a BAM file in Google Cloud Storage. Note that currently there may be some differences between exported BAM files and the original BAM file at the time of import. In particular, comments in the input file header will not be preserved, and some custom tags will be converted to strings.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The readset export request.
- "readsetIds": [ # The IDs of the readsets to export.
- "A String",
- ],
- "exportUri": "A String", # A Google Cloud Storage URI where the exported BAM file will be created. The currently authenticated user must have write access to the new file location. An error will be returned if the URI already contains data.
- "referenceNames": [ # The reference names to export. If this is not specified, all reference sequences, including unmapped reads, are exported. Use * to export only unmapped reads.
- "A String",
- ],
- "projectId": "A String", # The Google Developers Console project number that owns this export.
- }
-
-
-Returns:
- An object of the form:
-
- { # The readset export response.
- "jobId": "A String", # A job ID that can be used to get status information.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(readsetId)</code>
- <pre>Gets a readset by ID.
-
-Args:
- readsetId: string, The ID of the readset. (required)
-
-Returns:
- An object of the form:
-
- { # A Readset is a collection of Reads.
- "fileData": [ # File information from the original BAM import. See the BAM format specification for additional information on each field.
- { # The header section of the BAM/SAM file.
- "programs": [ # (@PG) Programs.
- {
- "commandLine": "A String", # (CL) Command line.
- "prevProgramId": "A String", # (PP) Previous program ID.
- "id": "A String", # (ID) Program record identifier.
- "version": "A String", # (VN) Program version.
- "name": "A String", # (PN) Program name.
- },
- ],
- "readGroups": [ # (@RG) Read group.
- {
- "sequencingTechnology": "A String", # (PL) Platform/technology used to produce the reads.
- "predictedInsertSize": 42, # (PI) Predicted median insert size.
- "sequencingCenterName": "A String", # (CN) Name of sequencing center producing the read.
- "description": "A String", # (DS) Description.
- "processingProgram": "A String", # (PG) Programs used for processing the read group.
- "platformUnit": "A String", # (PU) Platform unit.
- "flowOrder": "A String", # (FO) Flow order. The array of nucleotide bases that correspond to the nucleotides used for each flow of each read.
- "library": "A String", # (LS) Library.
- "sample": "A String", # (SM) Sample.
- "date": "A String", # (DT) Date the run was produced (ISO8601 date or date/time).
- "keySequence": "A String", # (KS) The array of nucleotide bases that correspond to the key sequence of each read.
- "id": "A String", # (ID) Read group identifier.
- },
- ],
- "filename": "A String", # The name of the file from which this data was imported.
- "headers": [ # (@HD) The header line.
- {
- "sortingOrder": "A String", # (SO) Sorting order of alignments.
- "version": "A String", # (VN) BAM format version.
- },
- ],
- "comments": [ # (@CO) One-line text comments.
- "A String",
- ],
- "refSequences": [ # (@SQ) Reference sequence dictionary.
- {
- "name": "A String", # (SN) Reference sequence name.
- "assemblyId": "A String", # (AS) Genome assembly identifier.
- "uri": "A String", # (UR) URI of the sequence.
- "length": 42, # (LN) Reference sequence length.
- "species": "A String", # (SP) Species.
- "md5Checksum": "A String", # (M5) MD5 checksum of the sequence in the uppercase, excluding spaces but including pads as *.
- },
- ],
- "fileUri": "A String", # [Deprecated] This field is deprecated and will no longer be populated. Please use filename instead.
- },
- ],
- "id": "A String", # The Google generated ID of the readset, immutable.
- "datasetId": "A String", # The ID of the dataset this readset belongs to.
- "name": "A String", # The readset name, typically this is the sample name.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="import_">import_(body)</code>
- <pre>Creates readsets by asynchronously importing the provided information. Note that currently comments in the input file header are not imported and some custom tags will be converted to strings, rather than preserving tag types. The caller must have WRITE permissions to the dataset.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The readset import request.
- "sourceUris": [ # A list of URIs pointing at BAM files in Google Cloud Storage.
- "A String",
- ],
- "datasetId": "A String", # Required. The ID of the dataset these readsets will belong to. The caller must have WRITE permissions to this dataset.
- }
-
-
-Returns:
- An object of the form:
-
- { # The readset import response.
- "jobId": "A String", # A job ID that can be used to get status information.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(readsetId, body)</code>
- <pre>Updates a readset. This method supports patch semantics.
-
-Args:
- readsetId: string, The ID of the readset to be updated. The caller must have WRITE permissions to the dataset associated with this readset. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Readset is a collection of Reads.
- "fileData": [ # File information from the original BAM import. See the BAM format specification for additional information on each field.
- { # The header section of the BAM/SAM file.
- "programs": [ # (@PG) Programs.
- {
- "commandLine": "A String", # (CL) Command line.
- "prevProgramId": "A String", # (PP) Previous program ID.
- "id": "A String", # (ID) Program record identifier.
- "version": "A String", # (VN) Program version.
- "name": "A String", # (PN) Program name.
- },
- ],
- "readGroups": [ # (@RG) Read group.
- {
- "sequencingTechnology": "A String", # (PL) Platform/technology used to produce the reads.
- "predictedInsertSize": 42, # (PI) Predicted median insert size.
- "sequencingCenterName": "A String", # (CN) Name of sequencing center producing the read.
- "description": "A String", # (DS) Description.
- "processingProgram": "A String", # (PG) Programs used for processing the read group.
- "platformUnit": "A String", # (PU) Platform unit.
- "flowOrder": "A String", # (FO) Flow order. The array of nucleotide bases that correspond to the nucleotides used for each flow of each read.
- "library": "A String", # (LS) Library.
- "sample": "A String", # (SM) Sample.
- "date": "A String", # (DT) Date the run was produced (ISO8601 date or date/time).
- "keySequence": "A String", # (KS) The array of nucleotide bases that correspond to the key sequence of each read.
- "id": "A String", # (ID) Read group identifier.
- },
- ],
- "filename": "A String", # The name of the file from which this data was imported.
- "headers": [ # (@HD) The header line.
- {
- "sortingOrder": "A String", # (SO) Sorting order of alignments.
- "version": "A String", # (VN) BAM format version.
- },
- ],
- "comments": [ # (@CO) One-line text comments.
- "A String",
- ],
- "refSequences": [ # (@SQ) Reference sequence dictionary.
- {
- "name": "A String", # (SN) Reference sequence name.
- "assemblyId": "A String", # (AS) Genome assembly identifier.
- "uri": "A String", # (UR) URI of the sequence.
- "length": 42, # (LN) Reference sequence length.
- "species": "A String", # (SP) Species.
- "md5Checksum": "A String", # (M5) MD5 checksum of the sequence in the uppercase, excluding spaces but including pads as *.
- },
- ],
- "fileUri": "A String", # [Deprecated] This field is deprecated and will no longer be populated. Please use filename instead.
- },
- ],
- "id": "A String", # The Google generated ID of the readset, immutable.
- "datasetId": "A String", # The ID of the dataset this readset belongs to.
- "name": "A String", # The readset name, typically this is the sample name.
-}
-
-
-Returns:
- An object of the form:
-
- { # A Readset is a collection of Reads.
- "fileData": [ # File information from the original BAM import. See the BAM format specification for additional information on each field.
- { # The header section of the BAM/SAM file.
- "programs": [ # (@PG) Programs.
- {
- "commandLine": "A String", # (CL) Command line.
- "prevProgramId": "A String", # (PP) Previous program ID.
- "id": "A String", # (ID) Program record identifier.
- "version": "A String", # (VN) Program version.
- "name": "A String", # (PN) Program name.
- },
- ],
- "readGroups": [ # (@RG) Read group.
- {
- "sequencingTechnology": "A String", # (PL) Platform/technology used to produce the reads.
- "predictedInsertSize": 42, # (PI) Predicted median insert size.
- "sequencingCenterName": "A String", # (CN) Name of sequencing center producing the read.
- "description": "A String", # (DS) Description.
- "processingProgram": "A String", # (PG) Programs used for processing the read group.
- "platformUnit": "A String", # (PU) Platform unit.
- "flowOrder": "A String", # (FO) Flow order. The array of nucleotide bases that correspond to the nucleotides used for each flow of each read.
- "library": "A String", # (LS) Library.
- "sample": "A String", # (SM) Sample.
- "date": "A String", # (DT) Date the run was produced (ISO8601 date or date/time).
- "keySequence": "A String", # (KS) The array of nucleotide bases that correspond to the key sequence of each read.
- "id": "A String", # (ID) Read group identifier.
- },
- ],
- "filename": "A String", # The name of the file from which this data was imported.
- "headers": [ # (@HD) The header line.
- {
- "sortingOrder": "A String", # (SO) Sorting order of alignments.
- "version": "A String", # (VN) BAM format version.
- },
- ],
- "comments": [ # (@CO) One-line text comments.
- "A String",
- ],
- "refSequences": [ # (@SQ) Reference sequence dictionary.
- {
- "name": "A String", # (SN) Reference sequence name.
- "assemblyId": "A String", # (AS) Genome assembly identifier.
- "uri": "A String", # (UR) URI of the sequence.
- "length": 42, # (LN) Reference sequence length.
- "species": "A String", # (SP) Species.
- "md5Checksum": "A String", # (M5) MD5 checksum of the sequence in the uppercase, excluding spaces but including pads as *.
- },
- ],
- "fileUri": "A String", # [Deprecated] This field is deprecated and will no longer be populated. Please use filename instead.
- },
- ],
- "id": "A String", # The Google generated ID of the readset, immutable.
- "datasetId": "A String", # The ID of the dataset this readset belongs to.
- "name": "A String", # The readset name, typically this is the sample name.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="search">search(body)</code>
- <pre>Gets a list of readsets matching the criteria.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The readset search request.
- "pageToken": "A String", # The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- "datasetIds": [ # Restricts this query to readsets within the given datasets. At least one ID must be provided.
- "A String",
- ],
- "name": "A String", # Only return readsets for which a substring of the name matches this string.
- "maxResults": "A String", # Specifies number of results to return in a single page. If unspecified, it will default to 128. The maximum value is 1024.
- }
-
-
-Returns:
- An object of the form:
-
- { # The readset search response.
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
- "readsets": [ # The list of matching Readsets.
- { # A Readset is a collection of Reads.
- "fileData": [ # File information from the original BAM import. See the BAM format specification for additional information on each field.
- { # The header section of the BAM/SAM file.
- "programs": [ # (@PG) Programs.
- {
- "commandLine": "A String", # (CL) Command line.
- "prevProgramId": "A String", # (PP) Previous program ID.
- "id": "A String", # (ID) Program record identifier.
- "version": "A String", # (VN) Program version.
- "name": "A String", # (PN) Program name.
- },
- ],
- "readGroups": [ # (@RG) Read group.
- {
- "sequencingTechnology": "A String", # (PL) Platform/technology used to produce the reads.
- "predictedInsertSize": 42, # (PI) Predicted median insert size.
- "sequencingCenterName": "A String", # (CN) Name of sequencing center producing the read.
- "description": "A String", # (DS) Description.
- "processingProgram": "A String", # (PG) Programs used for processing the read group.
- "platformUnit": "A String", # (PU) Platform unit.
- "flowOrder": "A String", # (FO) Flow order. The array of nucleotide bases that correspond to the nucleotides used for each flow of each read.
- "library": "A String", # (LS) Library.
- "sample": "A String", # (SM) Sample.
- "date": "A String", # (DT) Date the run was produced (ISO8601 date or date/time).
- "keySequence": "A String", # (KS) The array of nucleotide bases that correspond to the key sequence of each read.
- "id": "A String", # (ID) Read group identifier.
- },
- ],
- "filename": "A String", # The name of the file from which this data was imported.
- "headers": [ # (@HD) The header line.
- {
- "sortingOrder": "A String", # (SO) Sorting order of alignments.
- "version": "A String", # (VN) BAM format version.
- },
- ],
- "comments": [ # (@CO) One-line text comments.
- "A String",
- ],
- "refSequences": [ # (@SQ) Reference sequence dictionary.
- {
- "name": "A String", # (SN) Reference sequence name.
- "assemblyId": "A String", # (AS) Genome assembly identifier.
- "uri": "A String", # (UR) URI of the sequence.
- "length": 42, # (LN) Reference sequence length.
- "species": "A String", # (SP) Species.
- "md5Checksum": "A String", # (M5) MD5 checksum of the sequence in the uppercase, excluding spaces but including pads as *.
- },
- ],
- "fileUri": "A String", # [Deprecated] This field is deprecated and will no longer be populated. Please use filename instead.
- },
- ],
- "id": "A String", # The Google generated ID of the readset, immutable.
- "datasetId": "A String", # The ID of the dataset this readset belongs to.
- "name": "A String", # The readset name, typically this is the sample name.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(readsetId, body)</code>
- <pre>Updates a readset.
-
-Args:
- readsetId: string, The ID of the readset to be updated. The caller must have WRITE permissions to the dataset associated with this readset. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Readset is a collection of Reads.
- "fileData": [ # File information from the original BAM import. See the BAM format specification for additional information on each field.
- { # The header section of the BAM/SAM file.
- "programs": [ # (@PG) Programs.
- {
- "commandLine": "A String", # (CL) Command line.
- "prevProgramId": "A String", # (PP) Previous program ID.
- "id": "A String", # (ID) Program record identifier.
- "version": "A String", # (VN) Program version.
- "name": "A String", # (PN) Program name.
- },
- ],
- "readGroups": [ # (@RG) Read group.
- {
- "sequencingTechnology": "A String", # (PL) Platform/technology used to produce the reads.
- "predictedInsertSize": 42, # (PI) Predicted median insert size.
- "sequencingCenterName": "A String", # (CN) Name of sequencing center producing the read.
- "description": "A String", # (DS) Description.
- "processingProgram": "A String", # (PG) Programs used for processing the read group.
- "platformUnit": "A String", # (PU) Platform unit.
- "flowOrder": "A String", # (FO) Flow order. The array of nucleotide bases that correspond to the nucleotides used for each flow of each read.
- "library": "A String", # (LS) Library.
- "sample": "A String", # (SM) Sample.
- "date": "A String", # (DT) Date the run was produced (ISO8601 date or date/time).
- "keySequence": "A String", # (KS) The array of nucleotide bases that correspond to the key sequence of each read.
- "id": "A String", # (ID) Read group identifier.
- },
- ],
- "filename": "A String", # The name of the file from which this data was imported.
- "headers": [ # (@HD) The header line.
- {
- "sortingOrder": "A String", # (SO) Sorting order of alignments.
- "version": "A String", # (VN) BAM format version.
- },
- ],
- "comments": [ # (@CO) One-line text comments.
- "A String",
- ],
- "refSequences": [ # (@SQ) Reference sequence dictionary.
- {
- "name": "A String", # (SN) Reference sequence name.
- "assemblyId": "A String", # (AS) Genome assembly identifier.
- "uri": "A String", # (UR) URI of the sequence.
- "length": 42, # (LN) Reference sequence length.
- "species": "A String", # (SP) Species.
- "md5Checksum": "A String", # (M5) MD5 checksum of the sequence in the uppercase, excluding spaces but including pads as *.
- },
- ],
- "fileUri": "A String", # [Deprecated] This field is deprecated and will no longer be populated. Please use filename instead.
- },
- ],
- "id": "A String", # The Google generated ID of the readset, immutable.
- "datasetId": "A String", # The ID of the dataset this readset belongs to.
- "name": "A String", # The readset name, typically this is the sample name.
-}
-
-
-Returns:
- An object of the form:
-
- { # A Readset is a collection of Reads.
- "fileData": [ # File information from the original BAM import. See the BAM format specification for additional information on each field.
- { # The header section of the BAM/SAM file.
- "programs": [ # (@PG) Programs.
- {
- "commandLine": "A String", # (CL) Command line.
- "prevProgramId": "A String", # (PP) Previous program ID.
- "id": "A String", # (ID) Program record identifier.
- "version": "A String", # (VN) Program version.
- "name": "A String", # (PN) Program name.
- },
- ],
- "readGroups": [ # (@RG) Read group.
- {
- "sequencingTechnology": "A String", # (PL) Platform/technology used to produce the reads.
- "predictedInsertSize": 42, # (PI) Predicted median insert size.
- "sequencingCenterName": "A String", # (CN) Name of sequencing center producing the read.
- "description": "A String", # (DS) Description.
- "processingProgram": "A String", # (PG) Programs used for processing the read group.
- "platformUnit": "A String", # (PU) Platform unit.
- "flowOrder": "A String", # (FO) Flow order. The array of nucleotide bases that correspond to the nucleotides used for each flow of each read.
- "library": "A String", # (LS) Library.
- "sample": "A String", # (SM) Sample.
- "date": "A String", # (DT) Date the run was produced (ISO8601 date or date/time).
- "keySequence": "A String", # (KS) The array of nucleotide bases that correspond to the key sequence of each read.
- "id": "A String", # (ID) Read group identifier.
- },
- ],
- "filename": "A String", # The name of the file from which this data was imported.
- "headers": [ # (@HD) The header line.
- {
- "sortingOrder": "A String", # (SO) Sorting order of alignments.
- "version": "A String", # (VN) BAM format version.
- },
- ],
- "comments": [ # (@CO) One-line text comments.
- "A String",
- ],
- "refSequences": [ # (@SQ) Reference sequence dictionary.
- {
- "name": "A String", # (SN) Reference sequence name.
- "assemblyId": "A String", # (AS) Genome assembly identifier.
- "uri": "A String", # (UR) URI of the sequence.
- "length": 42, # (LN) Reference sequence length.
- "species": "A String", # (SP) Species.
- "md5Checksum": "A String", # (M5) MD5 checksum of the sequence in the uppercase, excluding spaces but including pads as *.
- },
- ],
- "fileUri": "A String", # [Deprecated] This field is deprecated and will no longer be populated. Please use filename instead.
- },
- ],
- "id": "A String", # The Google generated ID of the readset, immutable.
- "datasetId": "A String", # The ID of the dataset this readset belongs to.
- "name": "A String", # The readset name, typically this is the sample name.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1beta.variants.html b/docs/dyn/genomics_v1beta.variants.html
deleted file mode 100644
index feff752..0000000
--- a/docs/dyn/genomics_v1beta.variants.html
+++ /dev/null
@@ -1,491 +0,0 @@
-<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="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.variants.html">variants</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#create">create(body)</a></code></p>
-<p class="firstline">Creates a new variant.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(variantId)</a></code></p>
-<p class="firstline">Deletes a variant.</p>
-<p class="toc_element">
- <code><a href="#export">export(body)</a></code></p>
-<p class="firstline">Exports variant data to an external destination.</p>
-<p class="toc_element">
- <code><a href="#get">get(variantId)</a></code></p>
-<p class="firstline">Gets a variant by ID.</p>
-<p class="toc_element">
- <code><a href="#import_">import_(body)</a></code></p>
-<p class="firstline">Creates variant data by asynchronously importing the provided information. The variants for import will be merged with any existing data and each other according to the behavior of mergeVariants. In particular, this means for merged VCF variants that have conflicting INFO fields, some data will be arbitrarily discarded. As a special case, for single-sample VCF files, QUAL and FILTER fields will be moved to the call level; these are sometimes interpreted in a call-specific context. Imported VCF headers are appended to the metadata already in a VariantSet.</p>
-<p class="toc_element">
- <code><a href="#search">search(body)</a></code></p>
-<p class="firstline">Gets a list of variants matching the criteria.</p>
-<p class="toc_element">
- <code><a href="#update">update(variantId, body)</a></code></p>
-<p class="firstline">Updates a variant's names and info fields. All other modifications are silently ignored. Returns the modified variant without its calls.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(body)</code>
- <pre>Creates a new variant.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Variant represents a change in DNA sequence relative to some reference. For example, a Variant could represent a SNP or an insertion. Variants belong to a variant set.
- "info": { # A map of additional variant information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "variantSetId": "A String", # The ID of the variant set this variant belongs to.
- "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
- "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
- { # A Call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a Call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
- "info": { # A map of additional variant call information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
- 42,
- ],
- "callSetId": "A String", # The ID of the call set this variant call belongs to.
- "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
- "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec.
- 3.14,
- ],
- "callSetName": "A String", # The name of the call set this variant call belongs to.
- },
- ],
- "created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
- "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
- "A String",
- ],
- "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
- "names": [ # Names for the variant, for example a RefSNP ID.
- "A String",
- ],
- "alternateBases": [ # The bases that appear instead of the reference bases.
- "A String",
- ],
- "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
- "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
- "id": "A String", # The Google generated ID of the variant, immutable.
-}
-
-
-Returns:
- An object of the form:
-
- { # A Variant represents a change in DNA sequence relative to some reference. For example, a Variant could represent a SNP or an insertion. Variants belong to a variant set.
- "info": { # A map of additional variant information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "variantSetId": "A String", # The ID of the variant set this variant belongs to.
- "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
- "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
- { # A Call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a Call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
- "info": { # A map of additional variant call information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
- 42,
- ],
- "callSetId": "A String", # The ID of the call set this variant call belongs to.
- "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
- "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec.
- 3.14,
- ],
- "callSetName": "A String", # The name of the call set this variant call belongs to.
- },
- ],
- "created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
- "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
- "A String",
- ],
- "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
- "names": [ # Names for the variant, for example a RefSNP ID.
- "A String",
- ],
- "alternateBases": [ # The bases that appear instead of the reference bases.
- "A String",
- ],
- "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
- "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
- "id": "A String", # The Google generated ID of the variant, immutable.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(variantId)</code>
- <pre>Deletes a variant.
-
-Args:
- variantId: string, The ID of the variant to be deleted. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="export">export(body)</code>
- <pre>Exports variant data to an external destination.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The variant data export request.
- "variantSetId": "A String", # Required. The ID of the variant set that contains variant data which should be exported. The caller must have READ access to this variant set.
- "format": "A String", # The format for the exported data.
- "projectId": "A String", # The Google Cloud project number that owns the destination BigQuery dataset. The caller must have WRITE access to this project. This project will also own the resulting export job.
- "callSetIds": [ # If provided, only variant call information from the specified call sets will be exported. By default all variant calls are exported.
- "A String",
- ],
- "bigqueryDataset": "A String", # The BigQuery dataset to export data to. Note that this is distinct from the Genomics concept of "dataset".
- "bigqueryTable": "A String", # The BigQuery table to export data to. If the table doesn't exist, it will be created. If it already exists, it will be overwritten.
- }
-
-
-Returns:
- An object of the form:
-
- { # The variant data export response.
- "jobId": "A String", # A job ID that can be used to get status information.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(variantId)</code>
- <pre>Gets a variant by ID.
-
-Args:
- variantId: string, The ID of the variant. (required)
-
-Returns:
- An object of the form:
-
- { # A Variant represents a change in DNA sequence relative to some reference. For example, a Variant could represent a SNP or an insertion. Variants belong to a variant set.
- "info": { # A map of additional variant information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "variantSetId": "A String", # The ID of the variant set this variant belongs to.
- "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
- "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
- { # A Call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a Call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
- "info": { # A map of additional variant call information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
- 42,
- ],
- "callSetId": "A String", # The ID of the call set this variant call belongs to.
- "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
- "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec.
- 3.14,
- ],
- "callSetName": "A String", # The name of the call set this variant call belongs to.
- },
- ],
- "created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
- "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
- "A String",
- ],
- "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
- "names": [ # Names for the variant, for example a RefSNP ID.
- "A String",
- ],
- "alternateBases": [ # The bases that appear instead of the reference bases.
- "A String",
- ],
- "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
- "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
- "id": "A String", # The Google generated ID of the variant, immutable.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="import_">import_(body)</code>
- <pre>Creates variant data by asynchronously importing the provided information. The variants for import will be merged with any existing data and each other according to the behavior of mergeVariants. In particular, this means for merged VCF variants that have conflicting INFO fields, some data will be arbitrarily discarded. As a special case, for single-sample VCF files, QUAL and FILTER fields will be moved to the call level; these are sometimes interpreted in a call-specific context. Imported VCF headers are appended to the metadata already in a VariantSet.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The variant data import request.
- "variantSetId": "A String", # Required. The variant set to which variant data should be imported.
- "sourceUris": [ # A list of URIs pointing at VCF files in Google Cloud Storage. See the VCF Specification for more details on the input format.
- "A String",
- ],
- "format": "A String", # The format of the variant data being imported.
- }
-
-
-Returns:
- An object of the form:
-
- { # The variant data import response.
- "jobId": "A String", # A job ID that can be used to get status information.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="search">search(body)</code>
- <pre>Gets a list of variants matching the criteria.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The variant search request.
- "end": "A String", # Required. The end of the window (0-based, exclusive) for which overlapping variants should be returned.
- "pageSize": 42, # The maximum number of variants to return.
- "start": "A String", # Required. The beginning of the window (0-based, inclusive) for which overlapping variants should be returned.
- "maxCalls": 42, # The maximum number of calls to return. However, at least one variant will always be returned, even if it has more calls than this limit.
- "pageToken": "A String", # The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- "callSetIds": [ # Only return variant calls which belong to call sets with these ids. Leaving this blank returns all variant calls. If a variant has no calls belonging to any of these call sets, it won't be returned at all. Currently, variants with no calls from any call set will never be returned.
- "A String",
- ],
- "variantName": "A String", # Only return variants which have exactly this name.
- "referenceName": "A String", # Required. Only return variants in this reference sequence.
- "variantSetIds": [ # Exactly one variant set ID must be provided. Only variants from this variant set will be returned.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The variant search response.
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
- "variants": [ # The list of matching Variants.
- { # A Variant represents a change in DNA sequence relative to some reference. For example, a Variant could represent a SNP or an insertion. Variants belong to a variant set.
- "info": { # A map of additional variant information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "variantSetId": "A String", # The ID of the variant set this variant belongs to.
- "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
- "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
- { # A Call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a Call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
- "info": { # A map of additional variant call information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
- 42,
- ],
- "callSetId": "A String", # The ID of the call set this variant call belongs to.
- "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
- "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec.
- 3.14,
- ],
- "callSetName": "A String", # The name of the call set this variant call belongs to.
- },
- ],
- "created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
- "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
- "A String",
- ],
- "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
- "names": [ # Names for the variant, for example a RefSNP ID.
- "A String",
- ],
- "alternateBases": [ # The bases that appear instead of the reference bases.
- "A String",
- ],
- "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
- "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
- "id": "A String", # The Google generated ID of the variant, immutable.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(variantId, body)</code>
- <pre>Updates a variant's names and info fields. All other modifications are silently ignored. Returns the modified variant without its calls.
-
-Args:
- variantId: string, The ID of the variant to be updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Variant represents a change in DNA sequence relative to some reference. For example, a Variant could represent a SNP or an insertion. Variants belong to a variant set.
- "info": { # A map of additional variant information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "variantSetId": "A String", # The ID of the variant set this variant belongs to.
- "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
- "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
- { # A Call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a Call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
- "info": { # A map of additional variant call information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
- 42,
- ],
- "callSetId": "A String", # The ID of the call set this variant call belongs to.
- "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
- "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec.
- 3.14,
- ],
- "callSetName": "A String", # The name of the call set this variant call belongs to.
- },
- ],
- "created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
- "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
- "A String",
- ],
- "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
- "names": [ # Names for the variant, for example a RefSNP ID.
- "A String",
- ],
- "alternateBases": [ # The bases that appear instead of the reference bases.
- "A String",
- ],
- "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
- "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
- "id": "A String", # The Google generated ID of the variant, immutable.
-}
-
-
-Returns:
- An object of the form:
-
- { # A Variant represents a change in DNA sequence relative to some reference. For example, a Variant could represent a SNP or an insertion. Variants belong to a variant set.
- "info": { # A map of additional variant information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "variantSetId": "A String", # The ID of the variant set this variant belongs to.
- "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
- "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
- { # A Call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a Call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
- "info": { # A map of additional variant call information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
- 42,
- ],
- "callSetId": "A String", # The ID of the call set this variant call belongs to.
- "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
- "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec.
- 3.14,
- ],
- "callSetName": "A String", # The name of the call set this variant call belongs to.
- },
- ],
- "created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
- "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
- "A String",
- ],
- "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
- "names": [ # Names for the variant, for example a RefSNP ID.
- "A String",
- ],
- "alternateBases": [ # The bases that appear instead of the reference bases.
- "A String",
- ],
- "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
- "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
- "id": "A String", # The Google generated ID of the variant, immutable.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1beta.variantsets.html b/docs/dyn/genomics_v1beta.variantsets.html
deleted file mode 100644
index c254520..0000000
--- a/docs/dyn/genomics_v1beta.variantsets.html
+++ /dev/null
@@ -1,387 +0,0 @@
-<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="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.variantsets.html">variantsets</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(variantSetId)</a></code></p>
-<p class="firstline">Deletes the contents of a variant set. The variant set object is not deleted.</p>
-<p class="toc_element">
- <code><a href="#get">get(variantSetId)</a></code></p>
-<p class="firstline">Gets a variant set by ID.</p>
-<p class="toc_element">
- <code><a href="#mergeVariants">mergeVariants(variantSetId, body)</a></code></p>
-<p class="firstline">Merges the given variants with existing variants. Each variant will be merged with an existing variant that matches its reference sequence, start, end, reference bases, and alternative bases. If no such variant exists, a new one will be created.</p>
-<p class="toc_element">
- <code><a href="#patch">patch(variantSetId, body)</a></code></p>
-<p class="firstline">Updates a variant set's metadata. All other modifications are silently ignored. Returns the modified variant set. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#search">search(body)</a></code></p>
-<p class="firstline">Returns a list of all variant sets matching search criteria.</p>
-<p class="toc_element">
- <code><a href="#update">update(variantSetId, body)</a></code></p>
-<p class="firstline">Updates a variant set's metadata. All other modifications are silently ignored. Returns the modified variant set.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(variantSetId)</code>
- <pre>Deletes the contents of a variant set. The variant set object is not deleted.
-
-Args:
- variantSetId: string, The ID of the variant set to be deleted. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(variantSetId)</code>
- <pre>Gets a variant set by ID.
-
-Args:
- variantSetId: string, Required. The ID of the variant set. (required)
-
-Returns:
- An object of the form:
-
- { # A VariantSet represents a collection of Variants and their summary statistics.
- "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
- { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
- "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
- "referenceName": "A String", # The reference the bound is associate with.
- },
- ],
- "id": "A String", # The Google-generated ID of the variant set. Immutable.
- "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
- "metadata": [ # The metadata associated with this variant set.
- { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
- "info": { # Remaining structured metadata key-value pairs.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "description": "A String", # A textual description of this metadata.
- "number": "A String", # The number of values that can be included in a field described by this metadata.
- "value": "A String", # The value field for simple metadata
- "key": "A String", # The top-level key.
- "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
- "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="mergeVariants">mergeVariants(variantSetId, body)</code>
- <pre>Merges the given variants with existing variants. Each variant will be merged with an existing variant that matches its reference sequence, start, end, reference bases, and alternative bases. If no such variant exists, a new one will be created.
-
-When variants are merged, the call information from the new variant is added to the existing variant, and other fields (such as key/value pairs) are discarded.
-
-Args:
- variantSetId: string, The destination variant set. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "variants": [ # The variants to be merged with existing variants.
- { # A Variant represents a change in DNA sequence relative to some reference. For example, a Variant could represent a SNP or an insertion. Variants belong to a variant set.
- "info": { # A map of additional variant information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "variantSetId": "A String", # The ID of the variant set this variant belongs to.
- "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions.
- "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant.
- { # A Call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a Call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345.
- "info": { # A map of additional variant call information.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "genotype": [ # The genotype of this variant call. Each value represents either the value of the referenceBases field or a 1-based index into alternateBases. If a variant had a referenceBases value of T and an alternateBases value of ["A", "C"], and the genotype was [2, 1], that would mean the call represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype values is important if the phaseset is present. If a genotype is not called (that is, a . is present in the GT string) -1 is returned.
- 42,
- ],
- "callSetId": "A String", # The ID of the call set this variant call belongs to.
- "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.
- "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec.
- 3.14,
- ],
- "callSetName": "A String", # The name of the call set this variant call belongs to.
- },
- ],
- "created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given position.
- "filter": [ # A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.
- "A String",
- ],
- "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases.
- "names": [ # Names for the variant, for example a RefSNP ID.
- "A String",
- ],
- "alternateBases": [ # The bases that appear instead of the reference bases.
- "A String",
- ],
- "referenceName": "A String", # The reference on which this variant occurs. (such as chr20 or X)
- "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better.
- "id": "A String", # The Google generated ID of the variant, immutable.
- },
- ],
- }
-
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(variantSetId, body)</code>
- <pre>Updates a variant set's metadata. All other modifications are silently ignored. Returns the modified variant set. This method supports patch semantics.
-
-Args:
- variantSetId: string, The ID of the variant to be updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A VariantSet represents a collection of Variants and their summary statistics.
- "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
- { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
- "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
- "referenceName": "A String", # The reference the bound is associate with.
- },
- ],
- "id": "A String", # The Google-generated ID of the variant set. Immutable.
- "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
- "metadata": [ # The metadata associated with this variant set.
- { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
- "info": { # Remaining structured metadata key-value pairs.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "description": "A String", # A textual description of this metadata.
- "number": "A String", # The number of values that can be included in a field described by this metadata.
- "value": "A String", # The value field for simple metadata
- "key": "A String", # The top-level key.
- "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
- "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
- },
- ],
-}
-
-
-Returns:
- An object of the form:
-
- { # A VariantSet represents a collection of Variants and their summary statistics.
- "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
- { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
- "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
- "referenceName": "A String", # The reference the bound is associate with.
- },
- ],
- "id": "A String", # The Google-generated ID of the variant set. Immutable.
- "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
- "metadata": [ # The metadata associated with this variant set.
- { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
- "info": { # Remaining structured metadata key-value pairs.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "description": "A String", # A textual description of this metadata.
- "number": "A String", # The number of values that can be included in a field described by this metadata.
- "value": "A String", # The value field for simple metadata
- "key": "A String", # The top-level key.
- "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
- "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="search">search(body)</code>
- <pre>Returns a list of all variant sets matching search criteria.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The search variant sets request.
- "pageToken": "A String", # The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- "datasetIds": [ # Exactly one dataset ID must be provided here. Only variant sets which belong to this dataset will be returned.
- "A String",
- ],
- "pageSize": 42, # The maximum number of variant sets to return in a request.
- }
-
-
-Returns:
- An object of the form:
-
- { # The search variant sets response.
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
- "variantSets": [ # The variant sets belonging to the requested dataset.
- { # A VariantSet represents a collection of Variants and their summary statistics.
- "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
- { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
- "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
- "referenceName": "A String", # The reference the bound is associate with.
- },
- ],
- "id": "A String", # The Google-generated ID of the variant set. Immutable.
- "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
- "metadata": [ # The metadata associated with this variant set.
- { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
- "info": { # Remaining structured metadata key-value pairs.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "description": "A String", # A textual description of this metadata.
- "number": "A String", # The number of values that can be included in a field described by this metadata.
- "value": "A String", # The value field for simple metadata
- "key": "A String", # The top-level key.
- "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
- "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
- },
- ],
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(variantSetId, body)</code>
- <pre>Updates a variant set's metadata. All other modifications are silently ignored. Returns the modified variant set.
-
-Args:
- variantSetId: string, The ID of the variant to be updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A VariantSet represents a collection of Variants and their summary statistics.
- "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
- { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
- "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
- "referenceName": "A String", # The reference the bound is associate with.
- },
- ],
- "id": "A String", # The Google-generated ID of the variant set. Immutable.
- "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
- "metadata": [ # The metadata associated with this variant set.
- { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
- "info": { # Remaining structured metadata key-value pairs.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "description": "A String", # A textual description of this metadata.
- "number": "A String", # The number of values that can be included in a field described by this metadata.
- "value": "A String", # The value field for simple metadata
- "key": "A String", # The top-level key.
- "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
- "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
- },
- ],
-}
-
-
-Returns:
- An object of the form:
-
- { # A VariantSet represents a collection of Variants and their summary statistics.
- "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one.
- { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference.
- "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence.
- "referenceName": "A String", # The reference the bound is associate with.
- },
- ],
- "id": "A String", # The Google-generated ID of the variant set. Immutable.
- "datasetId": "A String", # The dataset to which this variant set belongs. Immutable.
- "metadata": [ # The metadata associated with this variant set.
- { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
- "info": { # Remaining structured metadata key-value pairs.
- "a_key": [ # A string which maps to an array of values.
- "A String",
- ],
- },
- "description": "A String", # A textual description of this metadata.
- "number": "A String", # The number of values that can be included in a field described by this metadata.
- "value": "A String", # The value field for simple metadata
- "key": "A String", # The top-level key.
- "type": "A String", # The type of data. Possible types include: Integer, Float, Flag, Character, and String.
- "id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v1beta3.projects.logServices.html b/docs/dyn/logging_v1beta3.projects.logServices.html
deleted file mode 100644
index 0ff29b6..0000000
--- a/docs/dyn/logging_v1beta3.projects.logServices.html
+++ /dev/null
@@ -1,135 +0,0 @@
-<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="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a> . <a href="logging_v1beta3.projects.logServices.html">logServices</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="logging_v1beta3.projects.logServices.indexes.html">indexes()</a></code>
-</p>
-<p class="firstline">Returns the indexes Resource.</p>
-
-<p class="toc_element">
- <code><a href="logging_v1beta3.projects.logServices.sinks.html">sinks()</a></code>
-</p>
-<p class="firstline">Returns the sinks Resource.</p>
-
-<p class="toc_element">
- <code><a href="#list">list(projectsId, log=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists the log services that have log entries in this 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="list">list(projectsId, log=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists the log services that have log entries in this project.
-
-Args:
- projectsId: string, Part of `projectName`. The resource name of the project whose services are to be listed. (required)
- log: string, If empty, all log services contributing log entries to the project are listed. Otherwise, this field must be the resource name of a log, such as `"projects/my-project/appengine.googleapis.com%2Frequest_log"`, and then the only services listed are those associated with entries in the log. A service is associated with an entry if its name is in the entry's `LogEntryMetadata.serviceName` field.
- pageSize: integer, The maximum number of `LogService` objects to return in one operation.
- pageToken: string, An opaque token, returned as `nextPageToken` by a prior `ListLogServices` operation. If `pageToken` is supplied, then the other fields of this request are ignored, and instead the previous `ListLogServices` operation is continued.
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Result returned from `ListLogServicesRequest`.
- "nextPageToken": "A String", # If there are more results, then `nextPageToken` is returned in the response. To get the next batch of services, use the value of `nextPageToken` as `pageToken` in the next call of `ListLogServices`. If `nextPageToken` is empty, then there are no more results.
- "logServices": [ # A list of log services.
- { # _Output only._ Describes a service that writes log entries.
- "indexKeys": [ # A list of the names of the keys used to index and label individual log entries from this service. The first two keys are used as the primary and secondary index, respectively. Additional keys may be used to label the entries. For example, App Engine indexes its entries by module and by version, so its `indexKeys` field is the following: [ "appengine.googleapis.com/module_id", "appengine.googleapis.com/version_id" ]
- "A String",
- ],
- "name": "A String", # The service's name. Example: `"appengine.googleapis.com"`. Log names beginning with this string are reserved for this service. This value can appear in the `LogEntry.metadata.serviceName` field of log entries associated with this log service.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/logging_v1beta3.projects.logServices.indexes.html b/docs/dyn/logging_v1beta3.projects.logServices.indexes.html
deleted file mode 100644
index 98903b0..0000000
--- a/docs/dyn/logging_v1beta3.projects.logServices.indexes.html
+++ /dev/null
@@ -1,123 +0,0 @@
-<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="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a> . <a href="logging_v1beta3.projects.logServices.html">logServices</a> . <a href="logging_v1beta3.projects.logServices.indexes.html">indexes</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(projectsId, logServicesId, pageSize=None, indexPrefix=None, x__xgafv=None, pageToken=None, log=None, depth=None)</a></code></p>
-<p class="firstline">Lists the current index values for a log service.</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(projectsId, logServicesId, pageSize=None, indexPrefix=None, x__xgafv=None, pageToken=None, log=None, depth=None)</code>
- <pre>Lists the current index values for a log service.
-
-Args:
- projectsId: string, Part of `serviceName`. The resource name of a log service whose service indexes are requested. Example: `"projects/my-project-id/logServices/appengine.googleapis.com"`. (required)
- logServicesId: string, Part of `serviceName`. See documentation of `projectsId`. (required)
- pageSize: integer, The maximum number of log service index resources to return in one operation.
- indexPrefix: string, Restricts the index values returned to be those with a specified prefix for each index key. This field has the form `"/prefix1/prefix2/..."`, in order corresponding to the [`LogService indexKeys`][google.logging.v1.LogService.index_keys]. Non-empty prefixes must begin with `/`. For example, App Engine's two keys are the module ID and the version ID. Following is the effect of using various values for `indexPrefix`: + `"/Mod/"` retrieves `/Mod/10` and `/Mod/11` but not `/ModA/10`. + `"/Mod` retrieves `/Mod/10`, `/Mod/11` and `/ModA/10` but not `/XXX/33`. + `"/Mod/1"` retrieves `/Mod/10` and `/Mod/11` but not `/ModA/10`. + `"/Mod/10/"` retrieves `/Mod/10` only. + An empty prefix or `"/"` retrieves all values.
- x__xgafv: string, V1 error format.
- pageToken: string, An opaque token, returned as `nextPageToken` by a prior `ListLogServiceIndexes` operation. If `pageToken` is supplied, then the other fields of this request are ignored, and instead the previous `ListLogServiceIndexes` operation is continued.
- log: string, _Optional_. The resource name of a log, such as `"projects/project_id/logs/log_name"`. If present, indexes are returned for any service associated with entries in the log.
- depth: integer, A non-negative integer that limits the number of levels of the index hierarchy that are returned. If `depth` is 1 (default), only the first index key value is returned. If `depth` is 2, both primary and secondary key values are returned. If `depth` is 0, the depth is the number of slash-separators in the `indexPrefix` field, not counting a slash appearing as the last character of the prefix. If the `indexPrefix` field is empty, the default depth is 1. It is an error for `depth` to be any positive value less than the number of components in `indexPrefix`.
-
-Returns:
- An object of the form:
-
- { # Result returned from ListLogServiceIndexesRequest.
- "nextPageToken": "A String", # If there are more results, then `nextPageToken` is returned in the response. To get the next batch of indexes, use the value of `nextPageToken` as `pageToken` in the next call of `ListLogServiceIndexes`. If `nextPageToken` is empty, then there are no more results.
- "serviceIndexPrefixes": [ # A list of log service index values. Each index value has the form `"/value1/value2/..."`, where `value1` is a value in the primary index, `value2` is a value in the secondary index, and so forth.
- "A String",
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/logging_v1beta3.projects.logServices.sinks.html b/docs/dyn/logging_v1beta3.projects.logServices.sinks.html
deleted file mode 100644
index dda274c..0000000
--- a/docs/dyn/logging_v1beta3.projects.logServices.sinks.html
+++ /dev/null
@@ -1,300 +0,0 @@
-<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="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a> . <a href="logging_v1beta3.projects.logServices.html">logServices</a> . <a href="logging_v1beta3.projects.logServices.sinks.html">sinks</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#create">create(projectsId, logServicesId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a log service sink. All log entries from a specified log service are written to the destination.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(projectsId, logServicesId, sinksId, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a log service sink. After deletion, no new log entries are written to the destination.</p>
-<p class="toc_element">
- <code><a href="#get">get(projectsId, logServicesId, sinksId, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets a log service sink.</p>
-<p class="toc_element">
- <code><a href="#list">list(projectsId, logServicesId, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists log service sinks associated with a log service.</p>
-<p class="toc_element">
- <code><a href="#update">update(projectsId, logServicesId, sinksId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates a log service sink. If the sink does not exist, it is created.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(projectsId, logServicesId, body, x__xgafv=None)</code>
- <pre>Creates a log service sink. All log entries from a specified log service are written to the destination.
-
-Args:
- projectsId: string, Part of `serviceName`. The resource name of the log service to which the sink is bound. (required)
- logServicesId: string, Part of `serviceName`. See documentation of `projectsId`. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }
-
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(projectsId, logServicesId, sinksId, x__xgafv=None)</code>
- <pre>Deletes a log service sink. After deletion, no new log entries are written to the destination.
-
-Args:
- projectsId: string, Part of `sinkName`. The resource name of the log service sink to delete. (required)
- logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(projectsId, logServicesId, sinksId, x__xgafv=None)</code>
- <pre>Gets a log service sink.
-
-Args:
- projectsId: string, Part of `sinkName`. The resource name of the log service sink to return. (required)
- logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(projectsId, logServicesId, x__xgafv=None)</code>
- <pre>Lists log service sinks associated with a log service.
-
-Args:
- projectsId: string, Part of `serviceName`. The log service whose sinks are wanted. (required)
- logServicesId: string, Part of `serviceName`. See documentation of `projectsId`. (required)
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Result returned from `ListLogServiceSinks`.
- "sinks": [ # The requested log service sinks. If a returned `LogSink` object has an empty `destination` field, the client can retrieve the complete `LogSink` object by calling `logServices.sinks.get`.
- { # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(projectsId, logServicesId, sinksId, body, x__xgafv=None)</code>
- <pre>Updates a log service sink. If the sink does not exist, it is created.
-
-Args:
- projectsId: string, Part of `sinkName`. The resource name of the log service sink to update. (required)
- logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }
-
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v1beta3.projects.logs.entries.html b/docs/dyn/logging_v1beta3.projects.logs.entries.html
deleted file mode 100644
index 55f5447..0000000
--- a/docs/dyn/logging_v1beta3.projects.logs.entries.html
+++ /dev/null
@@ -1,141 +0,0 @@
-<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="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a> . <a href="logging_v1beta3.projects.logs.html">logs</a> . <a href="logging_v1beta3.projects.logs.entries.html">entries</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#write">write(projectsId, logsId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Writes log entries to Cloud Logging. Each entry consists of a `LogEntry` object. You must fill in all the fields of the object, including one of the payload fields. You may supply a map, `commonLabels`, that holds default (key, value) data for the `entries[].metadata.labels` map in each entry, saving you the trouble of creating identical copies for each entry.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="write">write(projectsId, logsId, body, x__xgafv=None)</code>
- <pre>Writes log entries to Cloud Logging. Each entry consists of a `LogEntry` object. You must fill in all the fields of the object, including one of the payload fields. You may supply a map, `commonLabels`, that holds default (key, value) data for the `entries[].metadata.labels` map in each entry, saving you the trouble of creating identical copies for each entry.
-
-Args:
- projectsId: string, Part of `logName`. The resource name of the log that will receive the log entries. (required)
- logsId: string, Part of `logName`. See documentation of `projectsId`. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The parameters to WriteLogEntries.
- "commonLabels": { # Metadata labels that apply to all log entries in this request, so that you don't have to repeat them in each log entry's `metadata.labels` field. If any of the log entries contains a (key, value) with the same key that is in `commonLabels`, then the entry's (key, value) overrides the one in `commonLabels`.
- "a_key": "A String",
- },
- "entries": [ # Log entries to insert.
- { # An individual entry in a log.
- "httpRequest": { # A common proto for logging HTTP requests. # Information about the HTTP request associated with this log entry, if applicable.
- "status": 42, # A response code indicates the status of response, e.g., 200.
- "requestUrl": "A String", # Contains the scheme (http|https), the host name, the path and the query portion of the URL that was requested.
- "requestMethod": "A String", # Request method, such as `GET`, `HEAD`, `PUT` or `POST`.
- "referer": "A String", # Referer (a.k.a. referrer) URL of request, as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html.
- "remoteIp": "A String", # IP address of the client who issues the HTTP request. Could be either IPv4 or IPv6.
- "userAgent": "A String", # User agent sent by the client, e.g., "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)".
- "requestSize": "A String", # Size of the HTTP request message in bytes, including request headers and the request body.
- "responseSize": "A String", # Size of the HTTP response message in bytes sent back to the client, including response headers and response body.
- },
- "log": "A String", # The log to which this entry belongs. When a log entry is ingested, the value of this field is set by the logging system.
- "textPayload": "A String", # The log entry payload, represented as a text string.
- "structPayload": { # The log entry payload, represented as a structure that is expressed as a JSON object.
- "a_key": "", # Properties of the object.
- },
- "insertId": "A String", # A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same log with the same ID as duplicates which can be removed.
- "protoPayload": { # The log entry payload, represented as a protocol buffer that is expressed as a JSON object. You can only pass `protoPayload` values that belong to a set of approved types.
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- "metadata": { # Additional data that is associated with a log entry, set by the service creating the log entry. # Information about the log entry.
- "severity": "A String", # The severity of the log entry.
- "zone": "A String", # The zone of the Google Cloud Platform service that created the log entry. For example, `"us-central1-a"`.
- "timestamp": "A String", # The time the event described by the log entry occurred. Timestamps must be later than January 1, 1970.
- "region": "A String", # The region name of the Google Cloud Platform service that created the log entry. For example, `"us-central1"`.
- "labels": { # A set of (key, value) data that provides additional information about the log entry. If the log entry is from one of the Google Cloud Platform sources listed below, the indicated (key, value) information must be provided: Google App Engine, service_name `appengine.googleapis.com`: "appengine.googleapis.com/module_id", "appengine.googleapis.com/version_id", and one of: "appengine.googleapis.com/replica_index", "appengine.googleapis.com/clone_id", or else provide the following Compute Engine labels: Google Compute Engine, service_name `compute.googleapis.com`: "compute.googleapis.com/resource_type", "instance" "compute.googleapis.com/resource_id",
- "a_key": "A String",
- },
- "userId": "A String", # The fully-qualified email address of the authenticated user that performed or requested the action represented by the log entry. If the log entry does not apply to an action taken by an authenticated user, then the field should be empty.
- "serviceName": "A String", # The API name of the Google Cloud Platform service that created the log entry. For example, `"compute.googleapis.com"`.
- "projectId": "A String", # The project ID of the Google Cloud Platform service that created the log entry.
- },
- },
- ],
- }
-
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Result returned from WriteLogEntries. empty
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v1beta3.projects.logs.html b/docs/dyn/logging_v1beta3.projects.logs.html
deleted file mode 100644
index c8316e9..0000000
--- a/docs/dyn/logging_v1beta3.projects.logs.html
+++ /dev/null
@@ -1,154 +0,0 @@
-<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="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a> . <a href="logging_v1beta3.projects.logs.html">logs</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="logging_v1beta3.projects.logs.entries.html">entries()</a></code>
-</p>
-<p class="firstline">Returns the entries Resource.</p>
-
-<p class="toc_element">
- <code><a href="logging_v1beta3.projects.logs.sinks.html">sinks()</a></code>
-</p>
-<p class="firstline">Returns the sinks Resource.</p>
-
-<p class="toc_element">
- <code><a href="#delete">delete(projectsId, logsId, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a log and all its log entries. The log will reappear if it receives new entries.</p>
-<p class="toc_element">
- <code><a href="#list">list(projectsId, pageSize=None, serviceName=None, pageToken=None, x__xgafv=None, serviceIndexPrefix=None)</a></code></p>
-<p class="firstline">Lists the logs in the project. Only logs that have entries are listed.</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(projectsId, logsId, x__xgafv=None)</code>
- <pre>Deletes a log and all its log entries. The log will reappear if it receives new entries.
-
-Args:
- projectsId: string, Part of `logName`. The resource name of the log to be deleted. (required)
- logsId: string, Part of `logName`. See documentation of `projectsId`. (required)
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(projectsId, pageSize=None, serviceName=None, pageToken=None, x__xgafv=None, serviceIndexPrefix=None)</code>
- <pre>Lists the logs in the project. Only logs that have entries are listed.
-
-Args:
- projectsId: string, Part of `projectName`. The resource name of the project whose logs are requested. If both `serviceName` and `serviceIndexPrefix` are empty, then all logs with entries in this project are listed. (required)
- pageSize: integer, The maximum number of results to return.
- serviceName: string, If not empty, this field must be a log service name such as `"compute.googleapis.com"`. Only logs associated with that that log service are listed.
- pageToken: string, An opaque token, returned as `nextPageToken` by a prior `ListLogs` operation. If `pageToken` is supplied, then the other fields of this request are ignored, and instead the previous `ListLogs` operation is continued.
- x__xgafv: string, V1 error format.
- serviceIndexPrefix: string, The purpose of this field is to restrict the listed logs to those with entries of a certain kind. If `serviceName` is the name of a log service, then this field may contain values for the log service's indexes. Only logs that have entries whose indexes include the values are listed. The format for this field is `"/val1/val2.../valN"`, where `val1` is a value for the first index, `val2` for the second index, etc. An empty value (a single slash) for an index matches all values, and you can omit values for later indexes entirely.
-
-Returns:
- An object of the form:
-
- { # Result returned from ListLogs.
- "nextPageToken": "A String", # If there are more results, then `nextPageToken` is returned in the response. To get the next batch of logs, use the value of `nextPageToken` as `pageToken` in the next call of `ListLogs`. If `nextPageToken` is empty, then there are no more results.
- "logs": [ # A list of log descriptions matching the criteria.
- { # _Output only._ Describes a log, which is a named stream of log entries.
- "payloadType": "A String", # _Optional_. A URI representing the expected payload type for log entries.
- "displayName": "A String", # _Optional._ The common name of the log. Example: `"request_log"`.
- "name": "A String", # The resource name of the log. Example: `"/projects/my-gcp-project-id/logs/LOG_NAME"`, where `LOG_NAME` is the URL-encoded given name of the log. The log includes those log entries whose `LogEntry.log` field contains this given name. To avoid name collisions, it is a best practice to prefix the given log name with the service name, but this is not required. Examples of log given names: `"appengine.googleapis.com/request_log"`, `"apache-access"`.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/logging_v1beta3.projects.logs.sinks.html b/docs/dyn/logging_v1beta3.projects.logs.sinks.html
deleted file mode 100644
index 0795844..0000000
--- a/docs/dyn/logging_v1beta3.projects.logs.sinks.html
+++ /dev/null
@@ -1,300 +0,0 @@
-<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="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a> . <a href="logging_v1beta3.projects.logs.html">logs</a> . <a href="logging_v1beta3.projects.logs.sinks.html">sinks</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#create">create(projectsId, logsId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a log sink. All log entries for a specified log are written to the destination.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(projectsId, logsId, sinksId, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a log sink. After deletion, no new log entries are written to the destination.</p>
-<p class="toc_element">
- <code><a href="#get">get(projectsId, logsId, sinksId, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets a log sink.</p>
-<p class="toc_element">
- <code><a href="#list">list(projectsId, logsId, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists log sinks associated with a log.</p>
-<p class="toc_element">
- <code><a href="#update">update(projectsId, logsId, sinksId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates a log sink. If the sink does not exist, it is created.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(projectsId, logsId, body, x__xgafv=None)</code>
- <pre>Creates a log sink. All log entries for a specified log are written to the destination.
-
-Args:
- projectsId: string, Part of `logName`. The resource name of the log to which to the sink is bound. (required)
- logsId: string, Part of `logName`. See documentation of `projectsId`. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }
-
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(projectsId, logsId, sinksId, x__xgafv=None)</code>
- <pre>Deletes a log sink. After deletion, no new log entries are written to the destination.
-
-Args:
- projectsId: string, Part of `sinkName`. The resource name of the log sink to delete. (required)
- logsId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(projectsId, logsId, sinksId, x__xgafv=None)</code>
- <pre>Gets a log sink.
-
-Args:
- projectsId: string, Part of `sinkName`. The resource name of the log sink to return. (required)
- logsId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(projectsId, logsId, x__xgafv=None)</code>
- <pre>Lists log sinks associated with a log.
-
-Args:
- projectsId: string, Part of `logName`. The log whose sinks are wanted. For example, `"compute.google.com/syslog"`. (required)
- logsId: string, Part of `logName`. See documentation of `projectsId`. (required)
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Result returned from `ListLogSinks`.
- "sinks": [ # The requested log sinks. If a returned `LogSink` object has an empty `destination` field, the client can retrieve the complete `LogSink` object by calling `log.sinks.get`.
- { # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(projectsId, logsId, sinksId, body, x__xgafv=None)</code>
- <pre>Updates a log sink. If the sink does not exist, it is created.
-
-Args:
- projectsId: string, Part of `sinkName`. The resource name of the sink to update. (required)
- logsId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }
-
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v1beta3.projects.sinks.html b/docs/dyn/logging_v1beta3.projects.sinks.html
deleted file mode 100644
index 14a8913..0000000
--- a/docs/dyn/logging_v1beta3.projects.sinks.html
+++ /dev/null
@@ -1,295 +0,0 @@
-<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="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a> . <a href="logging_v1beta3.projects.sinks.html">sinks</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#create">create(projectsId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a project sink. A logs filter determines which log entries are written to the destination.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(projectsId, sinksId, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a project sink. After deletion, no new log entries are written to the destination.</p>
-<p class="toc_element">
- <code><a href="#get">get(projectsId, sinksId, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets a project sink.</p>
-<p class="toc_element">
- <code><a href="#list">list(projectsId, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists project sinks associated with a project.</p>
-<p class="toc_element">
- <code><a href="#update">update(projectsId, sinksId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates a project sink. If the sink does not exist, it is created. The destination, filter, or both may be updated.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(projectsId, body, x__xgafv=None)</code>
- <pre>Creates a project sink. A logs filter determines which log entries are written to the destination.
-
-Args:
- projectsId: string, Part of `projectName`. The resource name of the project to which the sink is bound. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }
-
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(projectsId, sinksId, x__xgafv=None)</code>
- <pre>Deletes a project sink. After deletion, no new log entries are written to the destination.
-
-Args:
- projectsId: string, Part of `sinkName`. The resource name of the project sink to delete. (required)
- sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(projectsId, sinksId, x__xgafv=None)</code>
- <pre>Gets a project sink.
-
-Args:
- projectsId: string, Part of `sinkName`. The resource name of the project sink to return. (required)
- sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(projectsId, x__xgafv=None)</code>
- <pre>Lists project sinks associated with a project.
-
-Args:
- projectsId: string, Part of `projectName`. The project whose sinks are wanted. (required)
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Result returned from `ListSinks`.
- "sinks": [ # The requested sinks. If a returned `LogSink` object has an empty `destination` field, the client can retrieve the complete `LogSink` object by calling `projects.sinks.get`.
- { # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(projectsId, sinksId, body, x__xgafv=None)</code>
- <pre>Updates a project sink. If the sink does not exist, it is created. The destination, filter, or both may be updated.
-
-Args:
- projectsId: string, Part of `sinkName`. The resource name of the project sink to update. (required)
- sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }
-
- x__xgafv: string, V1 error format.
-
-Returns:
- An object of the form:
-
- { # Describes where log entries are written outside of Cloud Logging.
- "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
- "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
- { # Describes a problem with a logging resource or operation.
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
- "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @ype with type URL.
- },
- ],
- },
- "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
- "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
- },
- ],
- "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
- "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dataflow_v1beta3.v1b3.html b/docs/dyn/logging_v2.billingAccounts.html
similarity index 79%
rename from docs/dyn/dataflow_v1beta3.v1b3.html
rename to docs/dyn/logging_v2.billingAccounts.html
index e81eb27..28a34a1 100644
--- a/docs/dyn/dataflow_v1beta3.v1b3.html
+++ b/docs/dyn/logging_v2.billingAccounts.html
@@ -72,11 +72,11 @@
</style>
-<h1><a href="dataflow_v1beta3.html">Google Dataflow API</a> . <a href="dataflow_v1beta3.v1b3.html">v1b3</a></h1>
+<h1><a href="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.billingAccounts.html">billingAccounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="dataflow_v1beta3.v1b3.projects.html">projects()</a></code>
+ <code><a href="logging_v2.billingAccounts.logs.html">logs()</a></code>
</p>
-<p class="firstline">Returns the projects Resource.</p>
+<p class="firstline">Returns the logs Resource.</p>
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v2.billingAccounts.logs.html b/docs/dyn/logging_v2.billingAccounts.logs.html
new file mode 100644
index 0000000..e606c59
--- /dev/null
+++ b/docs/dyn/logging_v2.billingAccounts.logs.html
@@ -0,0 +1,109 @@
+<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="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.billingAccounts.html">billingAccounts</a> . <a href="logging_v2.billingAccounts.logs.html">logs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(logName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a log and all its log entries.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(logName=None, x__xgafv=None)</code>
+ <pre>Deletes a log and all its log entries.
+The log will reappear if it receives new entries.
+
+Args:
+ logName: string, Required. The resource name of the log to delete. Example:
+`"projects/my-project/logs/syslog"`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v2.entries.html b/docs/dyn/logging_v2.entries.html
new file mode 100644
index 0000000..923dbaf
--- /dev/null
+++ b/docs/dyn/logging_v2.entries.html
@@ -0,0 +1,431 @@
+<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="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.entries.html">entries</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists log entries. Use this method to retrieve log entries from Cloud</p>
+<p class="toc_element">
+ <code><a href="#write">write(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Writes log entries to Stackdriver Logging. All log entries are</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(body, x__xgafv=None)</code>
+ <pre>Lists log entries. Use this method to retrieve log entries from Cloud
+Logging. For ways to export log entries, see
+[Exporting Logs](/logging/docs/export).
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The parameters to `ListLogEntries`.
+ "orderBy": "A String", # Optional. How the results should be sorted. Presently, the only permitted
+ # values are `"timestamp asc"` (default) and `"timestamp desc"`. The first
+ # option returns entries in order of increasing values of
+ # `LogEntry.timestamp` (oldest first), and the second option returns entries
+ # in order of decreasing timestamps (newest first). Entries with equal
+ # timestamps are returned in order of `LogEntry.insertId`.
+ "resourceNames": [ # Required. One or more cloud resources from which to retrieve log entries.
+ # Example: `"projects/my-project-1A"`, `"projects/1234567890"`. Projects
+ # listed in `projectIds` are added to this list.
+ "A String",
+ ],
+ "pageSize": 42, # Optional. The maximum number of results to return from this request.
+ # Non-positive values are ignored. The presence of `nextPageToken` in the
+ # response indicates that more results might be available.
+ "filter": "A String", # Optional. A filter that chooses which log entries to return. See [Advanced
+ # Logs Filters](/logging/docs/view/advanced_filters). Only log entries that
+ # match the filter are returned. An empty filter matches all log entries.
+ "pageToken": "A String", # Optional. If present, then retrieve the next batch of results from the
+ # preceding call to this method. `pageToken` must be the value of
+ # `nextPageToken` from the previous response. The values of other method
+ # parameters should be identical to those in the previous call.
+ "projectIds": [ # Deprecated. One or more project identifiers or project numbers from which
+ # to retrieve log entries. Examples: `"my-project-1A"`, `"1234567890"`. If
+ # present, these project identifiers are converted to resource format and
+ # added to the list of resources in `resourceNames`. Callers should use
+ # `resourceNames` rather than this parameter.
+ "A String",
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Result returned from `ListLogEntries`.
+ "nextPageToken": "A String", # If there might be more results than appear in this response, then
+ # `nextPageToken` is included. To get the next set of results, call this
+ # method again using the value of `nextPageToken` as `pageToken`.
+ "entries": [ # A list of log entries.
+ { # An individual entry in a log.
+ "httpRequest": { # A common proto for logging HTTP requests. Only contains semantics # Optional. Information about the HTTP request associated with this
+ # log entry, if applicable.
+ # defined by the HTTP specification. Product-specific logging
+ # information MUST be defined in a separate message.
+ "status": 42, # The response code indicating the status of response.
+ # Examples: 200, 404.
+ "cacheValidatedWithOriginServer": True or False, # Whether or not the response was validated with the origin server before
+ # being served from cache. This field is only meaningful if `cache_hit` is
+ # True.
+ "requestMethod": "A String", # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
+ "latency": "A String", # The request processing latency on the server, from the time the request was
+ # received until the response was sent.
+ "cacheFillBytes": "A String", # The number of HTTP response bytes inserted into cache. Set only when a
+ # cache fill was attempted.
+ "requestUrl": "A String", # The scheme (http, https), the host name, the path and the query
+ # portion of the URL that was requested.
+ # Example: `"http://example.com/some/info?color=red"`.
+ "serverIp": "A String", # The IP address (IPv4 or IPv6) of the origin server that the request was
+ # sent to.
+ "cacheLookup": True or False, # Whether or not a cache lookup was attempted.
+ "cacheHit": True or False, # Whether or not an entity was served from cache
+ # (with or without validation).
+ "referer": "A String", # The referer URL of the request, as defined in
+ # [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
+ "remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP
+ # request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
+ "userAgent": "A String", # The user agent sent by the client. Example:
+ # `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
+ "requestSize": "A String", # The size of the HTTP request message in bytes, including the request
+ # headers and the request body.
+ "responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes,
+ # including the response headers and the response body.
+ },
+ "resource": { # An object representing a resource that can be used for monitoring, logging, # Required. The monitored resource associated with this log entry.
+ # Example: a log entry that reports a database error would be
+ # associated with the monitored resource designating the particular
+ # database that reported the error.
+ # billing, or other purposes. Examples include virtual machine instances,
+ # databases, and storage devices such as disks. The `type` field identifies a
+ # MonitoredResourceDescriptor object that describes the resource's
+ # schema. Information in the `labels` field identifies the actual resource and
+ # its attributes according to the schema. For example, a particular Compute
+ # Engine VM instance could be represented by the following object, because the
+ # MonitoredResourceDescriptor for `"gce_instance"` has labels
+ # `"instance_id"` and `"zone"`:
+ #
+ # { "type": "gce_instance",
+ # "labels": { "instance_id": "12345678901234",
+ # "zone": "us-central1-a" }}
+ "labels": { # Required. Values for all of the labels listed in the associated monitored
+ # resource descriptor. For example, Cloud SQL databases use the labels
+ # `"database_id"` and `"zone"`.
+ "a_key": "A String",
+ },
+ "type": "A String", # Required. The monitored resource type. This field must match
+ # the `type` field of a MonitoredResourceDescriptor object. For
+ # example, the type of a Cloud SQL database is `"cloudsql_database"`.
+ },
+ "severity": "A String", # Optional. The severity of the log entry. The default value is
+ # `LogSeverity.DEFAULT`.
+ "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
+ "timestamp": "A String", # Optional. The time the event described by the log entry occurred. If
+ # omitted, Stackdriver Logging will use the time the log entry is received.
+ "labels": { # Optional. A set of user-defined (key, value) data that provides additional
+ # information about the log entry.
+ "a_key": "A String",
+ },
+ "insertId": "A String", # Optional. A unique ID for the log entry. If you provide this
+ # field, the logging service considers other log entries in the
+ # same project with the same ID as duplicates which can be removed. If
+ # omitted, Stackdriver Logging will generate a unique ID for this
+ # log entry.
+ "jsonPayload": { # The log entry payload, represented as a structure that
+ # is expressed as a JSON object.
+ "a_key": "", # Properties of the object.
+ },
+ "logName": "A String", # Required. The resource name of the log to which this log entry
+ # belongs. The format of the name is
+ # `"projects/<project-id>/logs/<log-id>"`. Examples:
+ # `"projects/my-projectid/logs/syslog"`,
+ # `"projects/my-projectid/logs/library.googleapis.com%2Fbook_log"`.
+ #
+ # The log ID part of resource name must be less than 512 characters
+ # long and can only include the following characters: upper and
+ # lower case alphanumeric characters: [A-Za-z0-9]; and punctuation
+ # characters: forward-slash, underscore, hyphen, and period.
+ # Forward-slash (`/`) characters in the log ID must be URL-encoded.
+ "protoPayload": { # The log entry payload, represented as a protocol buffer. Some
+ # Google Cloud Platform services use this field for their log
+ # entry payloads.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "operation": { # Additional information about a potentially long-running operation with which # Optional. Information about an operation associated with the log entry, if
+ # applicable.
+ # a log entry is associated.
+ "last": True or False, # Optional. Set this to True if this is the last log entry in the operation.
+ "id": "A String", # Optional. An arbitrary operation identifier. Log entries with the
+ # same identifier are assumed to be part of the same operation.
+ "producer": "A String", # Optional. An arbitrary producer identifier. The combination of
+ # `id` and `producer` must be globally unique. Examples for `producer`:
+ # `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`.
+ "first": True or False, # Optional. Set this to True if this is the first log entry in the operation.
+ },
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="write">write(body, x__xgafv=None)</code>
+ <pre>Writes log entries to Stackdriver Logging. All log entries are
+written by this method.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The parameters to WriteLogEntries.
+ "resource": { # An object representing a resource that can be used for monitoring, logging, # Optional. A default monitored resource object that is assigned to all log
+ # entries in `entries` that do not specify a value for `resource`. Example:
+ #
+ # { "type": "gce_instance",
+ # "labels": {
+ # "zone": "us-central1-a", "instance_id": "00000000000000000000" }}
+ #
+ # See LogEntry.
+ # billing, or other purposes. Examples include virtual machine instances,
+ # databases, and storage devices such as disks. The `type` field identifies a
+ # MonitoredResourceDescriptor object that describes the resource's
+ # schema. Information in the `labels` field identifies the actual resource and
+ # its attributes according to the schema. For example, a particular Compute
+ # Engine VM instance could be represented by the following object, because the
+ # MonitoredResourceDescriptor for `"gce_instance"` has labels
+ # `"instance_id"` and `"zone"`:
+ #
+ # { "type": "gce_instance",
+ # "labels": { "instance_id": "12345678901234",
+ # "zone": "us-central1-a" }}
+ "labels": { # Required. Values for all of the labels listed in the associated monitored
+ # resource descriptor. For example, Cloud SQL databases use the labels
+ # `"database_id"` and `"zone"`.
+ "a_key": "A String",
+ },
+ "type": "A String", # Required. The monitored resource type. This field must match
+ # the `type` field of a MonitoredResourceDescriptor object. For
+ # example, the type of a Cloud SQL database is `"cloudsql_database"`.
+ },
+ "partialSuccess": True or False, # Optional. Whether valid entries should be written even if some other
+ # entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
+ # entry is not written, the response status will be the error associated
+ # with one of the failed entries and include error details in the form of
+ # WriteLogEntriesPartialErrors.
+ "labels": { # Optional. Default labels that are added to the `labels` field of all log
+ # entries in `entries`. If a log entry already has a label with the same key
+ # as a label in this parameter, then the log entry's label is not changed.
+ # See LogEntry.
+ "a_key": "A String",
+ },
+ "logName": "A String", # Optional. A default log resource name that is assigned to all log entries
+ # in `entries` that do not specify a value for `log_name`. Example:
+ # `"projects/my-project/logs/syslog"`. See
+ # LogEntry.
+ "entries": [ # Required. The log entries to write. Values supplied for the fields
+ # `log_name`, `resource`, and `labels` in this `entries.write` request are
+ # added to those log entries that do not provide their own values for the
+ # fields.
+ #
+ # To improve throughput and to avoid exceeding the
+ # [quota limit](/logging/quota-policy) for calls to `entries.write`,
+ # you should write multiple log entries at once rather than
+ # calling this method for each individual log entry.
+ { # An individual entry in a log.
+ "httpRequest": { # A common proto for logging HTTP requests. Only contains semantics # Optional. Information about the HTTP request associated with this
+ # log entry, if applicable.
+ # defined by the HTTP specification. Product-specific logging
+ # information MUST be defined in a separate message.
+ "status": 42, # The response code indicating the status of response.
+ # Examples: 200, 404.
+ "cacheValidatedWithOriginServer": True or False, # Whether or not the response was validated with the origin server before
+ # being served from cache. This field is only meaningful if `cache_hit` is
+ # True.
+ "requestMethod": "A String", # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
+ "latency": "A String", # The request processing latency on the server, from the time the request was
+ # received until the response was sent.
+ "cacheFillBytes": "A String", # The number of HTTP response bytes inserted into cache. Set only when a
+ # cache fill was attempted.
+ "requestUrl": "A String", # The scheme (http, https), the host name, the path and the query
+ # portion of the URL that was requested.
+ # Example: `"http://example.com/some/info?color=red"`.
+ "serverIp": "A String", # The IP address (IPv4 or IPv6) of the origin server that the request was
+ # sent to.
+ "cacheLookup": True or False, # Whether or not a cache lookup was attempted.
+ "cacheHit": True or False, # Whether or not an entity was served from cache
+ # (with or without validation).
+ "referer": "A String", # The referer URL of the request, as defined in
+ # [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
+ "remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP
+ # request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
+ "userAgent": "A String", # The user agent sent by the client. Example:
+ # `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
+ "requestSize": "A String", # The size of the HTTP request message in bytes, including the request
+ # headers and the request body.
+ "responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes,
+ # including the response headers and the response body.
+ },
+ "resource": { # An object representing a resource that can be used for monitoring, logging, # Required. The monitored resource associated with this log entry.
+ # Example: a log entry that reports a database error would be
+ # associated with the monitored resource designating the particular
+ # database that reported the error.
+ # billing, or other purposes. Examples include virtual machine instances,
+ # databases, and storage devices such as disks. The `type` field identifies a
+ # MonitoredResourceDescriptor object that describes the resource's
+ # schema. Information in the `labels` field identifies the actual resource and
+ # its attributes according to the schema. For example, a particular Compute
+ # Engine VM instance could be represented by the following object, because the
+ # MonitoredResourceDescriptor for `"gce_instance"` has labels
+ # `"instance_id"` and `"zone"`:
+ #
+ # { "type": "gce_instance",
+ # "labels": { "instance_id": "12345678901234",
+ # "zone": "us-central1-a" }}
+ "labels": { # Required. Values for all of the labels listed in the associated monitored
+ # resource descriptor. For example, Cloud SQL databases use the labels
+ # `"database_id"` and `"zone"`.
+ "a_key": "A String",
+ },
+ "type": "A String", # Required. The monitored resource type. This field must match
+ # the `type` field of a MonitoredResourceDescriptor object. For
+ # example, the type of a Cloud SQL database is `"cloudsql_database"`.
+ },
+ "severity": "A String", # Optional. The severity of the log entry. The default value is
+ # `LogSeverity.DEFAULT`.
+ "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
+ "timestamp": "A String", # Optional. The time the event described by the log entry occurred. If
+ # omitted, Stackdriver Logging will use the time the log entry is received.
+ "labels": { # Optional. A set of user-defined (key, value) data that provides additional
+ # information about the log entry.
+ "a_key": "A String",
+ },
+ "insertId": "A String", # Optional. A unique ID for the log entry. If you provide this
+ # field, the logging service considers other log entries in the
+ # same project with the same ID as duplicates which can be removed. If
+ # omitted, Stackdriver Logging will generate a unique ID for this
+ # log entry.
+ "jsonPayload": { # The log entry payload, represented as a structure that
+ # is expressed as a JSON object.
+ "a_key": "", # Properties of the object.
+ },
+ "logName": "A String", # Required. The resource name of the log to which this log entry
+ # belongs. The format of the name is
+ # `"projects/<project-id>/logs/<log-id>"`. Examples:
+ # `"projects/my-projectid/logs/syslog"`,
+ # `"projects/my-projectid/logs/library.googleapis.com%2Fbook_log"`.
+ #
+ # The log ID part of resource name must be less than 512 characters
+ # long and can only include the following characters: upper and
+ # lower case alphanumeric characters: [A-Za-z0-9]; and punctuation
+ # characters: forward-slash, underscore, hyphen, and period.
+ # Forward-slash (`/`) characters in the log ID must be URL-encoded.
+ "protoPayload": { # The log entry payload, represented as a protocol buffer. Some
+ # Google Cloud Platform services use this field for their log
+ # entry payloads.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "operation": { # Additional information about a potentially long-running operation with which # Optional. Information about an operation associated with the log entry, if
+ # applicable.
+ # a log entry is associated.
+ "last": True or False, # Optional. Set this to True if this is the last log entry in the operation.
+ "id": "A String", # Optional. An arbitrary operation identifier. Log entries with the
+ # same identifier are assumed to be part of the same operation.
+ "producer": "A String", # Optional. An arbitrary producer identifier. The combination of
+ # `id` and `producer` must be globally unique. Examples for `producer`:
+ # `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`.
+ "first": True or False, # Optional. Set this to True if this is the first log entry in the operation.
+ },
+ },
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Result returned from WriteLogEntries.
+ # empty
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/deploymentmanager_v2beta2.html b/docs/dyn/logging_v2.html
similarity index 72%
rename from docs/dyn/deploymentmanager_v2beta2.html
rename to docs/dyn/logging_v2.html
index 3ea91f9..a13b9c1 100644
--- a/docs/dyn/deploymentmanager_v2beta2.html
+++ b/docs/dyn/logging_v2.html
@@ -72,32 +72,32 @@
</style>
-<h1><a href="deploymentmanager_v2beta2.html">Google Cloud Deployment Manager API V2</a></h1>
+<h1><a href="logging_v2.html">Stackdriver Logging API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="deploymentmanager_v2beta2.deployments.html">deployments()</a></code>
+ <code><a href="logging_v2.billingAccounts.html">billingAccounts()</a></code>
</p>
-<p class="firstline">Returns the deployments Resource.</p>
+<p class="firstline">Returns the billingAccounts Resource.</p>
<p class="toc_element">
- <code><a href="deploymentmanager_v2beta2.manifests.html">manifests()</a></code>
+ <code><a href="logging_v2.entries.html">entries()</a></code>
</p>
-<p class="firstline">Returns the manifests Resource.</p>
+<p class="firstline">Returns the entries Resource.</p>
<p class="toc_element">
- <code><a href="deploymentmanager_v2beta2.operations.html">operations()</a></code>
+ <code><a href="logging_v2.monitoredResourceDescriptors.html">monitoredResourceDescriptors()</a></code>
</p>
-<p class="firstline">Returns the operations Resource.</p>
+<p class="firstline">Returns the monitoredResourceDescriptors Resource.</p>
<p class="toc_element">
- <code><a href="deploymentmanager_v2beta2.resources.html">resources()</a></code>
+ <code><a href="logging_v2.organizations.html">organizations()</a></code>
</p>
-<p class="firstline">Returns the resources Resource.</p>
+<p class="firstline">Returns the organizations Resource.</p>
<p class="toc_element">
- <code><a href="deploymentmanager_v2beta2.types.html">types()</a></code>
+ <code><a href="logging_v2.projects.html">projects()</a></code>
</p>
-<p class="firstline">Returns the types Resource.</p>
+<p class="firstline">Returns the projects Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/logging_v2.monitoredResourceDescriptors.html b/docs/dyn/logging_v2.monitoredResourceDescriptors.html
new file mode 100644
index 0000000..8b8c22e
--- /dev/null
+++ b/docs/dyn/logging_v2.monitoredResourceDescriptors.html
@@ -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="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.monitoredResourceDescriptors.html">monitoredResourceDescriptors</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists the monitored resource descriptors used by Stackdriver Logging.</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(pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists the monitored resource descriptors used by Stackdriver Logging.
+
+Args:
+ pageSize: integer, Optional. The maximum number of results to return from this request.
+Non-positive values are ignored. The presence of `nextPageToken` in the
+response indicates that more results might be available.
+ pageToken: string, Optional. If present, then retrieve the next batch of results from the
+preceding call to this method. `pageToken` must be the value of
+`nextPageToken` from the previous response. The values of other method
+parameters should be identical to those in the previous call.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Result returned from ListMonitoredResourceDescriptors.
+ "nextPageToken": "A String", # If there might be more results than appear in this response, then
+ # `nextPageToken` is included. To get the next set of results, call this
+ # method again using the value of `nextPageToken` as `pageToken`.
+ "resourceDescriptors": [ # A list of resource descriptors.
+ { # An object that describes the schema of a MonitoredResource object using a
+ # type name and a set of labels. For example, the monitored resource
+ # descriptor for Google Compute Engine VM instances has a type of
+ # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
+ # `"zone"` to identify particular VM instances.
+ #
+ # Different APIs can support different monitored resource types. APIs generally
+ # provide a `list` method that returns the monitored resource descriptors used
+ # by the API.
+ "type": "A String", # Required. The monitored resource type. For example, the type
+ # `"cloudsql_database"` represents databases in Google Cloud SQL.
+ # The maximum length of this value is 256 characters.
+ "labels": [ # Required. A set of labels used to describe instances of this monitored
+ # resource type. For example, an individual Google Cloud SQL database is
+ # identified by values for the labels `"database_id"` and `"zone"`.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
+ # displayed in user interfaces. It should be a Title Cased Noun Phrase,
+ # without any article or other determiners. For example,
+ # `"Google Cloud SQL Database"`.
+ "description": "A String", # Optional. A detailed description of the monitored resource type that might
+ # be used in documentation.
+ "name": "A String", # Optional. The resource name of the monitored resource descriptor:
+ # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
+ # {type} is the value of the `type` field in this object and
+ # {project_id} is a project ID that provides API-specific context for
+ # accessing the type. APIs that do not use project information can use the
+ # resource name format `"monitoredResourceDescriptors/{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>
\ No newline at end of file
diff --git a/docs/dyn/logging_v1beta3.projects.html b/docs/dyn/logging_v2.organizations.html
similarity index 72%
copy from docs/dyn/logging_v1beta3.projects.html
copy to docs/dyn/logging_v2.organizations.html
index 644df0e..3dfd964 100644
--- a/docs/dyn/logging_v1beta3.projects.html
+++ b/docs/dyn/logging_v2.organizations.html
@@ -72,20 +72,15 @@
</style>
-<h1><a href="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a></h1>
+<h1><a href="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.organizations.html">organizations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="logging_v1beta3.projects.logServices.html">logServices()</a></code>
-</p>
-<p class="firstline">Returns the logServices Resource.</p>
-
-<p class="toc_element">
- <code><a href="logging_v1beta3.projects.logs.html">logs()</a></code>
+ <code><a href="logging_v2.organizations.logs.html">logs()</a></code>
</p>
<p class="firstline">Returns the logs Resource.</p>
<p class="toc_element">
- <code><a href="logging_v1beta3.projects.sinks.html">sinks()</a></code>
+ <code><a href="logging_v2.organizations.sinks.html">sinks()</a></code>
</p>
<p class="firstline">Returns the sinks Resource.</p>
diff --git a/docs/dyn/logging_v2.organizations.logs.html b/docs/dyn/logging_v2.organizations.logs.html
new file mode 100644
index 0000000..bfe24d2
--- /dev/null
+++ b/docs/dyn/logging_v2.organizations.logs.html
@@ -0,0 +1,109 @@
+<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="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.organizations.html">organizations</a> . <a href="logging_v2.organizations.logs.html">logs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(logName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a log and all its log entries.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(logName=None, x__xgafv=None)</code>
+ <pre>Deletes a log and all its log entries.
+The log will reappear if it receives new entries.
+
+Args:
+ logName: string, Required. The resource name of the log to delete. Example:
+`"projects/my-project/logs/syslog"`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v2.organizations.sinks.html b/docs/dyn/logging_v2.organizations.sinks.html
new file mode 100644
index 0000000..9a8f758
--- /dev/null
+++ b/docs/dyn/logging_v2.organizations.sinks.html
@@ -0,0 +1,477 @@
+<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="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.organizations.html">organizations</a> . <a href="logging_v2.organizations.sinks.html">sinks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a sink.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(sinkName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a sink.</p>
+<p class="toc_element">
+ <code><a href="#get">get(sinkName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a sink.</p>
+<p class="toc_element">
+ <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+<p class="firstline">Lists sinks.</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="#update">update(sinkName=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates or creates a sink.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
+ <pre>Creates a sink.
+
+Args:
+ parent: string, Required. The resource in which to create the sink.
+Example: `"projects/my-project-id"`.
+The new sink must be provided in the request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(sinkName=None, x__xgafv=None)</code>
+ <pre>Deletes a sink.
+
+Args:
+ sinkName: string, Required. The resource name of the sink to delete, including the parent
+resource and the sink identifier. Example:
+`"projects/my-project-id/sinks/my-sink-id"`. It is an error if the sink
+does not exist. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(sinkName=None, x__xgafv=None)</code>
+ <pre>Gets a sink.
+
+Args:
+ sinkName: string, Required. The resource name of the sink to return.
+Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <pre>Lists sinks.
+
+Args:
+ parent: string, Required. The cloud resource containing the sinks.
+Example: `"projects/my-logging-project"`. (required)
+ pageToken: string, Optional. If present, then retrieve the next batch of results from the
+preceding call to this method. `pageToken` must be the value of
+`nextPageToken` from the previous response. The values of other method
+parameters should be identical to those in the previous call.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ pageSize: integer, Optional. The maximum number of results to return from this request.
+Non-positive values are ignored. The presence of `nextPageToken` in the
+response indicates that more results might be available.
+
+Returns:
+ An object of the form:
+
+ { # Result returned from `ListSinks`.
+ "nextPageToken": "A String", # If there might be more results than appear in this response, then
+ # `nextPageToken` is included. To get the next set of results, call the same
+ # method again using the value of `nextPageToken` as `pageToken`.
+ "sinks": [ # A list of sinks.
+ { # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ },
+ ],
+ }</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="update">update(sinkName=None, body, x__xgafv=None)</code>
+ <pre>Updates or creates a sink.
+
+Args:
+ sinkName: string, Required. The resource name of the sink to update, including the parent
+resource and the sink identifier. If the sink does not exist, this method
+creates the sink. Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v1beta3.projects.html b/docs/dyn/logging_v2.projects.html
similarity index 73%
rename from docs/dyn/logging_v1beta3.projects.html
rename to docs/dyn/logging_v2.projects.html
index 644df0e..127333c 100644
--- a/docs/dyn/logging_v1beta3.projects.html
+++ b/docs/dyn/logging_v2.projects.html
@@ -72,20 +72,20 @@
</style>
-<h1><a href="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a></h1>
+<h1><a href="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="logging_v1beta3.projects.logServices.html">logServices()</a></code>
-</p>
-<p class="firstline">Returns the logServices Resource.</p>
-
-<p class="toc_element">
- <code><a href="logging_v1beta3.projects.logs.html">logs()</a></code>
+ <code><a href="logging_v2.projects.logs.html">logs()</a></code>
</p>
<p class="firstline">Returns the logs Resource.</p>
<p class="toc_element">
- <code><a href="logging_v1beta3.projects.sinks.html">sinks()</a></code>
+ <code><a href="logging_v2.projects.metrics.html">metrics()</a></code>
+</p>
+<p class="firstline">Returns the metrics Resource.</p>
+
+<p class="toc_element">
+ <code><a href="logging_v2.projects.sinks.html">sinks()</a></code>
</p>
<p class="firstline">Returns the sinks Resource.</p>
diff --git a/docs/dyn/logging_v2.projects.logs.html b/docs/dyn/logging_v2.projects.logs.html
new file mode 100644
index 0000000..061b09d
--- /dev/null
+++ b/docs/dyn/logging_v2.projects.logs.html
@@ -0,0 +1,109 @@
+<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="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.projects.html">projects</a> . <a href="logging_v2.projects.logs.html">logs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(logName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a log and all its log entries.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(logName=None, x__xgafv=None)</code>
+ <pre>Deletes a log and all its log entries.
+The log will reappear if it receives new entries.
+
+Args:
+ logName: string, Required. The resource name of the log to delete. Example:
+`"projects/my-project/logs/syslog"`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v2.projects.metrics.html b/docs/dyn/logging_v2.projects.metrics.html
new file mode 100644
index 0000000..7f2552b
--- /dev/null
+++ b/docs/dyn/logging_v2.projects.metrics.html
@@ -0,0 +1,335 @@
+<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="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.projects.html">projects</a> . <a href="logging_v2.projects.metrics.html">metrics</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a logs-based metric.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(metricName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a logs-based metric.</p>
+<p class="toc_element">
+ <code><a href="#get">get(metricName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a logs-based metric.</p>
+<p class="toc_element">
+ <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+<p class="firstline">Lists logs-based metrics.</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="#update">update(metricName=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates or updates a logs-based metric.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
+ <pre>Creates a logs-based metric.
+
+Args:
+ parent: string, The resource name of the project in which to create the metric.
+Example: `"projects/my-project-id"`.
+
+The new metric must be provided in the request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # characters and can include only the following characters: `A-Z`,
+ # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
+ # forward-slash character (`/`) denotes a hierarchy of name pieces,
+ # and it cannot be the first character of the name. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # characters and can include only the following characters: `A-Z`,
+ # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
+ # forward-slash character (`/`) denotes a hierarchy of name pieces,
+ # and it cannot be the first character of the name. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(metricName=None, x__xgafv=None)</code>
+ <pre>Deletes a logs-based metric.
+
+Args:
+ metricName: string, The resource name of the metric to delete.
+Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(metricName=None, x__xgafv=None)</code>
+ <pre>Gets a logs-based metric.
+
+Args:
+ metricName: string, The resource name of the desired metric.
+Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # characters and can include only the following characters: `A-Z`,
+ # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
+ # forward-slash character (`/`) denotes a hierarchy of name pieces,
+ # and it cannot be the first character of the name. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <pre>Lists logs-based metrics.
+
+Args:
+ parent: string, Required. The resource name containing the metrics.
+Example: `"projects/my-project-id"`. (required)
+ pageToken: string, Optional. If present, then retrieve the next batch of results from the
+preceding call to this method. `pageToken` must be the value of
+`nextPageToken` from the previous response. The values of other method
+parameters should be identical to those in the previous call.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ pageSize: integer, Optional. The maximum number of results to return from this request.
+Non-positive values are ignored. The presence of `nextPageToken` in the
+response indicates that more results might be available.
+
+Returns:
+ An object of the form:
+
+ { # Result returned from ListLogMetrics.
+ "metrics": [ # A list of logs-based metrics.
+ { # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # characters and can include only the following characters: `A-Z`,
+ # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
+ # forward-slash character (`/`) denotes a hierarchy of name pieces,
+ # and it cannot be the first character of the name. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
+ },
+ ],
+ "nextPageToken": "A String", # If there might be more results than appear in this response, then
+ # `nextPageToken` is included. To get the next set of results, call this
+ # method again using the value of `nextPageToken` as `pageToken`.
+ }</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="update">update(metricName=None, body, x__xgafv=None)</code>
+ <pre>Creates or updates a logs-based metric.
+
+Args:
+ metricName: string, The resource name of the metric to update.
+Example: `"projects/my-project-id/metrics/my-metric-id"`.
+
+The updated metric must be provided in the request and have the
+same identifier that is specified in `metricName`.
+If the metric does not exist, it is created. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # characters and can include only the following characters: `A-Z`,
+ # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
+ # forward-slash character (`/`) denotes a hierarchy of name pieces,
+ # and it cannot be the first character of the name. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes a logs-based metric. The value of the metric is the
+ # number of log entries that match a logs filter.
+ "filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Example: `"resource.type=gae_app AND severity>=ERROR"`.
+ "version": "A String", # Output only. The API version that created or updated this metric.
+ # The version also dictates the syntax of the filter expression. When a value
+ # for this field is missing, the default value of V2 should be assumed.
+ "description": "A String", # Optional. A description of this metric, which is used in documentation.
+ "name": "A String", # Required. The client-assigned metric identifier. Example:
+ # `"severe_errors"`. Metric identifiers are limited to 100
+ # characters and can include only the following characters: `A-Z`,
+ # `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
+ # forward-slash character (`/`) denotes a hierarchy of name pieces,
+ # and it cannot be the first character of the name. The '%' character
+ # is used to URL encode unsafe and reserved characters and must be
+ # followed by two hexadecimal digits according to RFC 1738.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v2.projects.sinks.html b/docs/dyn/logging_v2.projects.sinks.html
new file mode 100644
index 0000000..2866ef9
--- /dev/null
+++ b/docs/dyn/logging_v2.projects.sinks.html
@@ -0,0 +1,477 @@
+<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="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.projects.html">projects</a> . <a href="logging_v2.projects.sinks.html">sinks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a sink.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(sinkName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a sink.</p>
+<p class="toc_element">
+ <code><a href="#get">get(sinkName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a sink.</p>
+<p class="toc_element">
+ <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+<p class="firstline">Lists sinks.</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="#update">update(sinkName=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates or creates a sink.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
+ <pre>Creates a sink.
+
+Args:
+ parent: string, Required. The resource in which to create the sink.
+Example: `"projects/my-project-id"`.
+The new sink must be provided in the request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(sinkName=None, x__xgafv=None)</code>
+ <pre>Deletes a sink.
+
+Args:
+ sinkName: string, Required. The resource name of the sink to delete, including the parent
+resource and the sink identifier. Example:
+`"projects/my-project-id/sinks/my-sink-id"`. It is an error if the sink
+does not exist. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(sinkName=None, x__xgafv=None)</code>
+ <pre>Gets a sink.
+
+Args:
+ sinkName: string, Required. The resource name of the sink to return.
+Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <pre>Lists sinks.
+
+Args:
+ parent: string, Required. The cloud resource containing the sinks.
+Example: `"projects/my-logging-project"`. (required)
+ pageToken: string, Optional. If present, then retrieve the next batch of results from the
+preceding call to this method. `pageToken` must be the value of
+`nextPageToken` from the previous response. The values of other method
+parameters should be identical to those in the previous call.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ pageSize: integer, Optional. The maximum number of results to return from this request.
+Non-positive values are ignored. The presence of `nextPageToken` in the
+response indicates that more results might be available.
+
+Returns:
+ An object of the form:
+
+ { # Result returned from `ListSinks`.
+ "nextPageToken": "A String", # If there might be more results than appear in this response, then
+ # `nextPageToken` is included. To get the next set of results, call the same
+ # method again using the value of `nextPageToken` as `pageToken`.
+ "sinks": [ # A list of sinks.
+ { # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ },
+ ],
+ }</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="update">update(sinkName=None, body, x__xgafv=None)</code>
+ <pre>Updates or creates a sink.
+
+Args:
+ sinkName: string, Required. The resource name of the sink to update, including the parent
+resource and the sink identifier. If the sink does not exist, this method
+creates the sink. Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+ "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
+ # Only log entries matching the filter are exported. The filter
+ # must be consistent with the log entry format specified by the
+ # `outputVersionFormat` parameter, regardless of the format of the
+ # log entry that was originally written to Stackdriver Logging.
+ # Example filter (V2 format):
+ #
+ # logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
+ # access. This may be a service account or a group.
+ # Examples (Do not assume these specific values):
+ # "serviceAccount:cloud-logs@system.gserviceaccount.com"
+ # "group:cloud-logs@google.com"
+ #
+ # For GCS destinations, the role "roles/owner" is required on the bucket
+ # For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+ # required on the topic
+ # For BigQuery, the role "roles/editor" is required on the dataset
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v2beta1.entries.html b/docs/dyn/logging_v2beta1.entries.html
index 76f5428..7edc1f3 100644
--- a/docs/dyn/logging_v2beta1.entries.html
+++ b/docs/dyn/logging_v2beta1.entries.html
@@ -98,7 +98,7 @@
# `LogEntry.timestamp` (oldest first), and the second option returns entries
# in order of decreasing timestamps (newest first). Entries with equal
# timestamps are returned in order of `LogEntry.insertId`.
- "resourceNames": [ # Optional. One or more cloud resources from which to retrieve log entries.
+ "resourceNames": [ # Required. One or more cloud resources from which to retrieve log entries.
# Example: `"projects/my-project-1A"`, `"projects/1234567890"`. Projects
# listed in `projectIds` are added to this list.
"A String",
diff --git a/docs/dyn/logging_v2beta1.projects.sinks.html b/docs/dyn/logging_v2beta1.projects.sinks.html
index 2ff8f0e..d3136c9 100644
--- a/docs/dyn/logging_v2beta1.projects.sinks.html
+++ b/docs/dyn/logging_v2beta1.projects.sinks.html
@@ -104,7 +104,20 @@
body: object, The request body. (required)
The object takes the form of:
-{ # Describes a sink used to export log entries outside Stackdriver Logging.
+{ # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
"filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Only log entries matching the filter are exported. The filter
# must be consistent with the log entry format specified by the
@@ -113,14 +126,15 @@
# Example filter (V2 format):
#
# logName=projects/my-projectid/logs/syslog AND severity>=ERROR
- "destination": "A String", # Required. The export destination. See
- # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
- # Examples:
- #
- # "storage.googleapis.com/my-gcs-bucket"
- # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
- # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
- "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
# access. This may be a service account or a group.
# Examples (Do not assume these specific values):
# "serviceAccount:cloud-logs@system.gserviceaccount.com"
@@ -130,15 +144,6 @@
# For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
# required on the topic
# For BigQuery, the role "roles/editor" is required on the dataset
- "name": "A String", # Required. The client-assigned sink identifier, unique within the
- # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
- # limited to 1000 characters and can include only the following characters:
- # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
- # of the name is 100 characters.
- "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
- # entries. This version does not have to correspond to the version of the
- # log entry that was written to Stackdriver Logging. If omitted, the
- # v2 format is used.
}
x__xgafv: string, V1 error format.
@@ -149,7 +154,20 @@
Returns:
An object of the form:
- { # Describes a sink used to export log entries outside Stackdriver Logging.
+ { # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
"filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Only log entries matching the filter are exported. The filter
# must be consistent with the log entry format specified by the
@@ -158,14 +176,15 @@
# Example filter (V2 format):
#
# logName=projects/my-projectid/logs/syslog AND severity>=ERROR
- "destination": "A String", # Required. The export destination. See
- # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
- # Examples:
- #
- # "storage.googleapis.com/my-gcs-bucket"
- # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
- # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
- "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
# access. This may be a service account or a group.
# Examples (Do not assume these specific values):
# "serviceAccount:cloud-logs@system.gserviceaccount.com"
@@ -175,15 +194,6 @@
# For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
# required on the topic
# For BigQuery, the role "roles/editor" is required on the dataset
- "name": "A String", # Required. The client-assigned sink identifier, unique within the
- # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
- # limited to 1000 characters and can include only the following characters:
- # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
- # of the name is 100 characters.
- "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
- # entries. This version does not have to correspond to the version of the
- # log entry that was written to Stackdriver Logging. If omitted, the
- # v2 format is used.
}</pre>
</div>
@@ -231,7 +241,20 @@
Returns:
An object of the form:
- { # Describes a sink used to export log entries outside Stackdriver Logging.
+ { # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
"filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Only log entries matching the filter are exported. The filter
# must be consistent with the log entry format specified by the
@@ -240,14 +263,15 @@
# Example filter (V2 format):
#
# logName=projects/my-projectid/logs/syslog AND severity>=ERROR
- "destination": "A String", # Required. The export destination. See
- # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
- # Examples:
- #
- # "storage.googleapis.com/my-gcs-bucket"
- # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
- # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
- "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
# access. This may be a service account or a group.
# Examples (Do not assume these specific values):
# "serviceAccount:cloud-logs@system.gserviceaccount.com"
@@ -257,15 +281,6 @@
# For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
# required on the topic
# For BigQuery, the role "roles/editor" is required on the dataset
- "name": "A String", # Required. The client-assigned sink identifier, unique within the
- # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
- # limited to 1000 characters and can include only the following characters:
- # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
- # of the name is 100 characters.
- "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
- # entries. This version does not have to correspond to the version of the
- # log entry that was written to Stackdriver Logging. If omitted, the
- # v2 format is used.
}</pre>
</div>
@@ -296,7 +311,20 @@
# `nextPageToken` is included. To get the next set of results, call the same
# method again using the value of `nextPageToken` as `pageToken`.
"sinks": [ # A list of sinks.
- { # Describes a sink used to export log entries outside Stackdriver Logging.
+ { # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
"filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Only log entries matching the filter are exported. The filter
# must be consistent with the log entry format specified by the
@@ -305,14 +333,15 @@
# Example filter (V2 format):
#
# logName=projects/my-projectid/logs/syslog AND severity>=ERROR
- "destination": "A String", # Required. The export destination. See
- # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
- # Examples:
- #
- # "storage.googleapis.com/my-gcs-bucket"
- # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
- # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
- "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
# access. This may be a service account or a group.
# Examples (Do not assume these specific values):
# "serviceAccount:cloud-logs@system.gserviceaccount.com"
@@ -322,15 +351,6 @@
# For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
# required on the topic
# For BigQuery, the role "roles/editor" is required on the dataset
- "name": "A String", # Required. The client-assigned sink identifier, unique within the
- # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
- # limited to 1000 characters and can include only the following characters:
- # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
- # of the name is 100 characters.
- "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
- # entries. This version does not have to correspond to the version of the
- # log entry that was written to Stackdriver Logging. If omitted, the
- # v2 format is used.
},
],
}</pre>
@@ -361,7 +381,20 @@
body: object, The request body. (required)
The object takes the form of:
-{ # Describes a sink used to export log entries outside Stackdriver Logging.
+{ # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
"filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Only log entries matching the filter are exported. The filter
# must be consistent with the log entry format specified by the
@@ -370,14 +403,15 @@
# Example filter (V2 format):
#
# logName=projects/my-projectid/logs/syslog AND severity>=ERROR
- "destination": "A String", # Required. The export destination. See
- # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
- # Examples:
- #
- # "storage.googleapis.com/my-gcs-bucket"
- # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
- # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
- "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
# access. This may be a service account or a group.
# Examples (Do not assume these specific values):
# "serviceAccount:cloud-logs@system.gserviceaccount.com"
@@ -387,15 +421,6 @@
# For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
# required on the topic
# For BigQuery, the role "roles/editor" is required on the dataset
- "name": "A String", # Required. The client-assigned sink identifier, unique within the
- # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
- # limited to 1000 characters and can include only the following characters:
- # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
- # of the name is 100 characters.
- "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
- # entries. This version does not have to correspond to the version of the
- # log entry that was written to Stackdriver Logging. If omitted, the
- # v2 format is used.
}
x__xgafv: string, V1 error format.
@@ -406,7 +431,20 @@
Returns:
An object of the form:
- { # Describes a sink used to export log entries outside Stackdriver Logging.
+ { # Describes a sink used to export log entries outside of Stackdriver Logging.
+ "endTime": "A String", # Optional. Time at which this sink expires.
+ "name": "A String", # Required. The client-assigned sink identifier, unique within the
+ # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
+ # limited to 1000 characters and can include only the following characters:
+ # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
+ # of the name is 100 characters.
+ "destination": "A String", # Required. The export destination. See
+ # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
+ # Examples:
+ #
+ # "storage.googleapis.com/my-gcs-bucket"
+ # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+ # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
"filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Only log entries matching the filter are exported. The filter
# must be consistent with the log entry format specified by the
@@ -415,14 +453,15 @@
# Example filter (V2 format):
#
# logName=projects/my-projectid/logs/syslog AND severity>=ERROR
- "destination": "A String", # Required. The export destination. See
- # [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs).
- # Examples:
- #
- # "storage.googleapis.com/my-gcs-bucket"
- # "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
- # "pubsub.googleapis.com/projects/my-project/topics/my-topic"
- "writerIdentity": "A String", # Output only. The iam identity to which the destination needs to grant write
+ "startTime": "A String", # Optional. Time range for which this sink is active.
+ # Logs are exported only if start_time <= entry.timestamp < end_time
+ # Both start_time and end_time may be omitted to specify
+ # (half) infinite ranges. The start_time must be less than the end_time.
+ "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
+ # entries. This version does not have to correspond to the version of the
+ # log entry that was written to Stackdriver Logging. If omitted, the
+ # v2 format is used.
+ "writerIdentity": "A String", # Output only. The IAM identity to which the destination needs to grant write
# access. This may be a service account or a group.
# Examples (Do not assume these specific values):
# "serviceAccount:cloud-logs@system.gserviceaccount.com"
@@ -432,15 +471,6 @@
# For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
# required on the topic
# For BigQuery, the role "roles/editor" is required on the dataset
- "name": "A String", # Required. The client-assigned sink identifier, unique within the
- # project. Example: `"my-syslog-errors-to-pubsub"`. Sink identifiers are
- # limited to 1000 characters and can include only the following characters:
- # `A-Z`, `a-z`, `0-9`, and the special characters `_-.`. The maximum length
- # of the name is 100 characters.
- "outputVersionFormat": "A String", # Optional. The log entry version to use for this sink's exported log
- # entries. This version does not have to correspond to the version of the
- # log entry that was written to Stackdriver Logging. If omitted, the
- # v2 format is used.
}</pre>
</div>
diff --git a/docs/dyn/manager_v1beta2.deployments.html b/docs/dyn/manager_v1beta2.deployments.html
deleted file mode 100644
index 16299f3..0000000
--- a/docs/dyn/manager_v1beta2.deployments.html
+++ /dev/null
@@ -1,405 +0,0 @@
-<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="manager_v1beta2.html">Deployment Manager API</a> . <a href="manager_v1beta2.deployments.html">deployments</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(projectId, region, deploymentName)</a></code></p>
-<p class="firstline"></p>
-<p class="toc_element">
- <code><a href="#get">get(projectId, region, deploymentName)</a></code></p>
-<p class="firstline"></p>
-<p class="toc_element">
- <code><a href="#insert">insert(projectId, region, body)</a></code></p>
-<p class="firstline"></p>
-<p class="toc_element">
- <code><a href="#list">list(projectId, region, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline"></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(projectId, region, deploymentName)</code>
- <pre>
-
-Args:
- projectId: string, A parameter (required)
- region: string, A parameter (required)
- deploymentName: string, A parameter (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(projectId, region, deploymentName)</code>
- <pre>
-
-Args:
- projectId: string, A parameter (required)
- region: string, A parameter (required)
- deploymentName: string, A parameter (required)
-
-Returns:
- An object of the form:
-
- { # A deployment represents a physical instantiation of a Template.
- "description": "A String", # A user-supplied description of this Deployment.
- "templateName": "A String", # The name of the Template on which this deployment is based.
- "overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
- { # A specification for overriding parameters in a Template that corresponds to the Deployment.
- "path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
- "value": "A String", # The new value to assign to the overridden parameter.
- },
- ],
- "modules": { # [Output Only] List of status for the modules in this deployment.
- "a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
- "healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
- "healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
- },
- "replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
- "resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
- "replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
- },
- "networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
- "networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
- },
- "state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
- "status": "A String", # [Output Only] The status of the deployment. Possible values include:
- # - UNKNOWN
- # - DEPLOYING
- # - DEPLOYED
- # - DEPLOYMENT_FAILED
- # - DELETING
- # - DELETED
- # - DELETE_FAILED
- "details": "A String", # [Output Only] Human readable details about the current state.
- },
- "autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
- "autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
- },
- "firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
- "firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
- },
- "type": "A String", # [Output Only] The type of the module.
- "lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
- "forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
- "targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
- },
- },
- },
- "state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
- "status": "A String", # [Output Only] The status of the deployment. Possible values include:
- # - UNKNOWN
- # - DEPLOYING
- # - DEPLOYED
- # - DEPLOYMENT_FAILED
- # - DELETING
- # - DELETED
- # - DELETE_FAILED
- "details": "A String", # [Output Only] Human readable details about the current state.
- },
- "creationDate": "A String", # [Output Only] The time when this deployment was created.
- "name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(projectId, region, body)</code>
- <pre>
-
-Args:
- projectId: string, A parameter (required)
- region: string, A parameter (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A deployment represents a physical instantiation of a Template.
- "description": "A String", # A user-supplied description of this Deployment.
- "templateName": "A String", # The name of the Template on which this deployment is based.
- "overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
- { # A specification for overriding parameters in a Template that corresponds to the Deployment.
- "path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
- "value": "A String", # The new value to assign to the overridden parameter.
- },
- ],
- "modules": { # [Output Only] List of status for the modules in this deployment.
- "a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
- "healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
- "healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
- },
- "replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
- "resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
- "replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
- },
- "networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
- "networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
- },
- "state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
- "status": "A String", # [Output Only] The status of the deployment. Possible values include:
- # - UNKNOWN
- # - DEPLOYING
- # - DEPLOYED
- # - DEPLOYMENT_FAILED
- # - DELETING
- # - DELETED
- # - DELETE_FAILED
- "details": "A String", # [Output Only] Human readable details about the current state.
- },
- "autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
- "autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
- },
- "firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
- "firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
- },
- "type": "A String", # [Output Only] The type of the module.
- "lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
- "forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
- "targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
- },
- },
- },
- "state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
- "status": "A String", # [Output Only] The status of the deployment. Possible values include:
- # - UNKNOWN
- # - DEPLOYING
- # - DEPLOYED
- # - DEPLOYMENT_FAILED
- # - DELETING
- # - DELETED
- # - DELETE_FAILED
- "details": "A String", # [Output Only] Human readable details about the current state.
- },
- "creationDate": "A String", # [Output Only] The time when this deployment was created.
- "name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
- }
-
-
-Returns:
- An object of the form:
-
- { # A deployment represents a physical instantiation of a Template.
- "description": "A String", # A user-supplied description of this Deployment.
- "templateName": "A String", # The name of the Template on which this deployment is based.
- "overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
- { # A specification for overriding parameters in a Template that corresponds to the Deployment.
- "path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
- "value": "A String", # The new value to assign to the overridden parameter.
- },
- ],
- "modules": { # [Output Only] List of status for the modules in this deployment.
- "a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
- "healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
- "healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
- },
- "replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
- "resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
- "replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
- },
- "networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
- "networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
- },
- "state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
- "status": "A String", # [Output Only] The status of the deployment. Possible values include:
- # - UNKNOWN
- # - DEPLOYING
- # - DEPLOYED
- # - DEPLOYMENT_FAILED
- # - DELETING
- # - DELETED
- # - DELETE_FAILED
- "details": "A String", # [Output Only] Human readable details about the current state.
- },
- "autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
- "autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
- },
- "firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
- "firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
- },
- "type": "A String", # [Output Only] The type of the module.
- "lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
- "forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
- "targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
- },
- },
- },
- "state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
- "status": "A String", # [Output Only] The status of the deployment. Possible values include:
- # - UNKNOWN
- # - DEPLOYING
- # - DEPLOYED
- # - DEPLOYMENT_FAILED
- # - DELETING
- # - DELETED
- # - DELETE_FAILED
- "details": "A String", # [Output Only] Human readable details about the current state.
- },
- "creationDate": "A String", # [Output Only] The time when this deployment was created.
- "name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(projectId, region, pageToken=None, maxResults=None)</code>
- <pre>
-
-Args:
- projectId: string, A parameter (required)
- region: string, A parameter (required)
- pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
- maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String",
- "resources": [
- { # A deployment represents a physical instantiation of a Template.
- "description": "A String", # A user-supplied description of this Deployment.
- "templateName": "A String", # The name of the Template on which this deployment is based.
- "overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
- { # A specification for overriding parameters in a Template that corresponds to the Deployment.
- "path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
- "value": "A String", # The new value to assign to the overridden parameter.
- },
- ],
- "modules": { # [Output Only] List of status for the modules in this deployment.
- "a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
- "healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
- "healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
- },
- "replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
- "resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
- "replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
- },
- "networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
- "networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
- },
- "state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
- "status": "A String", # [Output Only] The status of the deployment. Possible values include:
- # - UNKNOWN
- # - DEPLOYING
- # - DEPLOYED
- # - DEPLOYMENT_FAILED
- # - DELETING
- # - DELETED
- # - DELETE_FAILED
- "details": "A String", # [Output Only] Human readable details about the current state.
- },
- "autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
- "autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
- },
- "firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
- "firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
- },
- "type": "A String", # [Output Only] The type of the module.
- "lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
- "forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
- "targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
- },
- },
- },
- "state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
- "status": "A String", # [Output Only] The status of the deployment. Possible values include:
- # - UNKNOWN
- # - DEPLOYING
- # - DEPLOYED
- # - DEPLOYMENT_FAILED
- # - DELETING
- # - DELETED
- # - DELETE_FAILED
- "details": "A String", # [Output Only] Human readable details about the current state.
- },
- "creationDate": "A String", # [Output Only] The time when this deployment was created.
- "name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/manager_v1beta2.templates.html b/docs/dyn/manager_v1beta2.templates.html
deleted file mode 100644
index a6b124d..0000000
--- a/docs/dyn/manager_v1beta2.templates.html
+++ /dev/null
@@ -1,809 +0,0 @@
-<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="manager_v1beta2.html">Deployment Manager API</a> . <a href="manager_v1beta2.templates.html">templates</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(projectId, templateName)</a></code></p>
-<p class="firstline"></p>
-<p class="toc_element">
- <code><a href="#get">get(projectId, templateName)</a></code></p>
-<p class="firstline"></p>
-<p class="toc_element">
- <code><a href="#insert">insert(projectId, body)</a></code></p>
-<p class="firstline"></p>
-<p class="toc_element">
- <code><a href="#list">list(projectId, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline"></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(projectId, templateName)</code>
- <pre>
-
-Args:
- projectId: string, A parameter (required)
- templateName: string, A parameter (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(projectId, templateName)</code>
- <pre>
-
-Args:
- projectId: string, A parameter (required)
- templateName: string, A parameter (required)
-
-Returns:
- An object of the form:
-
- { # A Template represents a complete configuration for a Deployment.
- "modules": { # A list of modules for this Template.
- "a_key": { # A module in a configuration. A module represents a single homogeneous, possibly replicated task. # Name of the module. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
- "lbModule": {
- "description": "A String",
- "portRange": "A String",
- "sessionAffinity": "A String",
- "ipProtocol": "A String",
- "healthChecks": [
- "A String",
- ],
- "ipAddress": "A String",
- "targetModules": [
- "A String",
- ],
- },
- "networkModule": {
- "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.
- "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 typicall the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "description": "A String", # The description of the network.
- },
- "firewallModule": { # A Firewall resource
- "network": "A String", # The NetworkModule to which this firewall should apply. If not specified, or if specified as 'default', this firewall will be applied to the 'default' network.
- "sourceTags": [ # Source Tags to apply this firewall to, see the GCE Spec for details on syntax
- "A String",
- ],
- "sourceRanges": [ # Source IP ranges to apply this firewall to, see the GCE Spec for details on syntax
- "A String",
- ],
- "targetTags": [ # Target Tags to apply this firewall to, see the GCE Spec for details on syntax
- "A String",
- ],
- "allowed": [ # The allowed ports or port ranges.
- { # An allowed port resource.
- "IPProtocol": "A String", # ?tcp?, ?udp? or ?icmp?
- "ports": [ # List of ports or port ranges (Example inputs include: ["22"], [?33?, "12345-12349"].
- "A String",
- ],
- },
- ],
- "description": "A String", # The description of the firewall (optional)
- },
- "healthCheckModule": {
- "description": "A String",
- "timeoutSec": 42,
- "checkIntervalSec": 42,
- "unhealthyThreshold": 42,
- "healthyThreshold": 42,
- "host": "A String",
- "path": "A String",
- "port": 42,
- },
- "autoscalingModule": {
- "maxNumReplicas": 42,
- "description": "A String",
- "targetModule": "A String",
- "targetUtilization": 3.14, # target_utilization should be in range [0,1].
- "signalType": "A String",
- "coolDownPeriodSec": 42,
- "minNumReplicas": 42,
- },
- "replicaPoolModule": {
- "numReplicas": 42, # Number of replicas in this module.
- "healthChecks": [ # The Health Checks to configure for the ReplicaPoolModule
- "A String",
- ],
- "resourceView": "A String", # [Output Only] The name of the Resource View associated with a ReplicaPoolModule. This field will be generated by the service.
- "envVariables": { # A list of environment variables.
- "a_key": { # An environment variable. # Name of the environment variable. The name must conform to the following regular expression: [a-zA-Z_]+[a-zA-Z0-9_]+.
- "hidden": True or False, # Whether this variable is hidden or visible.
- "value": "A String", # Value of the environment variable.
- },
- },
- "replicaPoolParams": { # Configuration information for a ReplicaPools resource. Specifying an item within will determine the ReplicaPools API version used for a ReplicaPoolModule. Only one may be specified. # Information for a ReplicaPoolModule.
- "v1beta1": { # Configuration information for a ReplicaPools v1beta1 API resource. Directly maps to ReplicaPool InitTemplate. # ReplicaPoolParams specifications for use with ReplicaPools v1beta1.
- "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
- { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica.
- "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be <instance_name>-<five_random_charactersgt;.
- "diskSizeGb": "A String", # The size of the created disk in gigabytes.
- "sourceImage": "A String", # The fully-qualified URL of a source image to use to create this disk.
- "diskType": "A String", # Name of the disk type resource describing which disk type to use to create the disk. For example 'pd-ssd' or 'pd-standard'. Default is 'pd-standard'
- },
- "boot": True or False, # If true, indicates that this is the root persistent disk.
- "attachment": { # How to attach a disk to a Replica. # How the disk will be attached to the Replica.
- "deviceName": "A String", # The device name of this disk.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
- },
- "autoDelete": True or False, # If true, then this disk will be deleted when the instance is deleted.
- },
- ],
- "autoRestart": True or False, # Whether these replicas should be restarted if they experience a failure. The default value is true.
- "canIpForward": True or False, # Enables IP Forwarding
- "description": "A String", # An optional textual description of the resource.
- "zone": "A String", # The zone for this ReplicaPool.
- "tags": { # A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource. # A list of tags to apply to the Google Compute Engine instance to identify resources.
- "items": [ # Items contained in this tag.
- "A String",
- ],
- "fingerPrint": "A String", # The fingerprint of the tag.
- },
- "onHostMaintenance": "A String",
- "disksToAttach": [ # A list of existing Persistent Disk resources to attach to each replica in the pool. Each disk will be attached in read-only mode to every replica.
- { # A pre-existing persistent disk that will be attached to every Replica in the Pool.
- "source": "A String", # The fully-qualified URL of the Persistent Disk resource. It must be in the same zone as the Pool.
- "attachment": { # How to attach a disk to a Replica. # Optional. How the disk will be attached to the Replica.
- "deviceName": "A String", # The device name of this disk.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
- },
- },
- ],
- "machineType": "A String", # The machine type for this instance. Either a complete URL, or the resource name (e.g. n1-standard-1).
- "baseInstanceName": "A String", # The base name for instances within this ReplicaPool.
- "initAction": "A String", # Name of the Action to be run during initialization of a ReplicaPoolModule.
- "networkInterfaces": [ # A list of network interfaces for the instance. Currently only one interface is supported by Google Compute Engine.
- { # A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource.
- "accessConfigs": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services
- { # A Compute Engine network accessConfig. Identical to the accessConfig on corresponding Compute Engine resource.
- "type": "A String", # Type of this access configuration file. (Currently only ONE_TO_ONE_NAT is legal.)
- "name": "A String", # Name of this access configuration.
- "natIp": "A String", # An external IP address associated with this instance.
- },
- ],
- "networkIp": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface.
- "name": "A String", # Name of the interface.
- "network": "A String", # The name of the NetworkModule to which this interface applies. If not specified, or specified as 'default', this will use the 'default' network.
- },
- ],
- "serviceAccounts": [ # A list of Service Accounts to enable for this instance.
- { # A Compute Engine service account, identical to the Compute Engine resource.
- "scopes": [ # List of OAuth2 scopes to obtain for the service account.
- "A String",
- ],
- "email": "A String", # Service account email address.
- },
- ],
- "metadata": { # A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource. # The metadata key/value pairs assigned to this instance.
- "items": [ # A list of metadata items.
- { # A Compute Engine metadata item, defined as a key:value pair. Identical to the metadata on the corresponding Compute Engine resource.
- "value": "A String", # A metadata value.
- "key": "A String", # A metadata key.
- },
- ],
- "fingerPrint": "A String", # The fingerprint of the metadata.
- },
- },
- },
- },
- "type": "A String", # The type of this module. Valid values ("AUTOSCALING", "FIREWALL", "HEALTH_CHECK", "LOAD_BALANCING", "NETWORK", "REPLICA_POOL")
- },
- },
- "description": "A String", # A user-supplied description of this Template.
- "actions": { # Action definitions for use in Module intents in this Template.
- "a_key": { # An Action encapsulates a set of commands as a single runnable module with additional information needed during run-time. # The name of this action, used when specifying Actions in Module definitions.
- "timeoutMs": 42, # The timeout in milliseconds for this action to run.
- "commands": [ # A list of commands to run sequentially for this action.
- "A String",
- ],
- },
- },
- "name": "A String", # Name of this Template. The name must conform to the expression: [a-zA-Z0-9-_]{1,64}
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(projectId, body)</code>
- <pre>
-
-Args:
- projectId: string, A parameter (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Template represents a complete configuration for a Deployment.
- "modules": { # A list of modules for this Template.
- "a_key": { # A module in a configuration. A module represents a single homogeneous, possibly replicated task. # Name of the module. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
- "lbModule": {
- "description": "A String",
- "portRange": "A String",
- "sessionAffinity": "A String",
- "ipProtocol": "A String",
- "healthChecks": [
- "A String",
- ],
- "ipAddress": "A String",
- "targetModules": [
- "A String",
- ],
- },
- "networkModule": {
- "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.
- "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 typicall the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "description": "A String", # The description of the network.
- },
- "firewallModule": { # A Firewall resource
- "network": "A String", # The NetworkModule to which this firewall should apply. If not specified, or if specified as 'default', this firewall will be applied to the 'default' network.
- "sourceTags": [ # Source Tags to apply this firewall to, see the GCE Spec for details on syntax
- "A String",
- ],
- "sourceRanges": [ # Source IP ranges to apply this firewall to, see the GCE Spec for details on syntax
- "A String",
- ],
- "targetTags": [ # Target Tags to apply this firewall to, see the GCE Spec for details on syntax
- "A String",
- ],
- "allowed": [ # The allowed ports or port ranges.
- { # An allowed port resource.
- "IPProtocol": "A String", # ?tcp?, ?udp? or ?icmp?
- "ports": [ # List of ports or port ranges (Example inputs include: ["22"], [?33?, "12345-12349"].
- "A String",
- ],
- },
- ],
- "description": "A String", # The description of the firewall (optional)
- },
- "healthCheckModule": {
- "description": "A String",
- "timeoutSec": 42,
- "checkIntervalSec": 42,
- "unhealthyThreshold": 42,
- "healthyThreshold": 42,
- "host": "A String",
- "path": "A String",
- "port": 42,
- },
- "autoscalingModule": {
- "maxNumReplicas": 42,
- "description": "A String",
- "targetModule": "A String",
- "targetUtilization": 3.14, # target_utilization should be in range [0,1].
- "signalType": "A String",
- "coolDownPeriodSec": 42,
- "minNumReplicas": 42,
- },
- "replicaPoolModule": {
- "numReplicas": 42, # Number of replicas in this module.
- "healthChecks": [ # The Health Checks to configure for the ReplicaPoolModule
- "A String",
- ],
- "resourceView": "A String", # [Output Only] The name of the Resource View associated with a ReplicaPoolModule. This field will be generated by the service.
- "envVariables": { # A list of environment variables.
- "a_key": { # An environment variable. # Name of the environment variable. The name must conform to the following regular expression: [a-zA-Z_]+[a-zA-Z0-9_]+.
- "hidden": True or False, # Whether this variable is hidden or visible.
- "value": "A String", # Value of the environment variable.
- },
- },
- "replicaPoolParams": { # Configuration information for a ReplicaPools resource. Specifying an item within will determine the ReplicaPools API version used for a ReplicaPoolModule. Only one may be specified. # Information for a ReplicaPoolModule.
- "v1beta1": { # Configuration information for a ReplicaPools v1beta1 API resource. Directly maps to ReplicaPool InitTemplate. # ReplicaPoolParams specifications for use with ReplicaPools v1beta1.
- "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
- { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica.
- "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be <instance_name>-<five_random_charactersgt;.
- "diskSizeGb": "A String", # The size of the created disk in gigabytes.
- "sourceImage": "A String", # The fully-qualified URL of a source image to use to create this disk.
- "diskType": "A String", # Name of the disk type resource describing which disk type to use to create the disk. For example 'pd-ssd' or 'pd-standard'. Default is 'pd-standard'
- },
- "boot": True or False, # If true, indicates that this is the root persistent disk.
- "attachment": { # How to attach a disk to a Replica. # How the disk will be attached to the Replica.
- "deviceName": "A String", # The device name of this disk.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
- },
- "autoDelete": True or False, # If true, then this disk will be deleted when the instance is deleted.
- },
- ],
- "autoRestart": True or False, # Whether these replicas should be restarted if they experience a failure. The default value is true.
- "canIpForward": True or False, # Enables IP Forwarding
- "description": "A String", # An optional textual description of the resource.
- "zone": "A String", # The zone for this ReplicaPool.
- "tags": { # A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource. # A list of tags to apply to the Google Compute Engine instance to identify resources.
- "items": [ # Items contained in this tag.
- "A String",
- ],
- "fingerPrint": "A String", # The fingerprint of the tag.
- },
- "onHostMaintenance": "A String",
- "disksToAttach": [ # A list of existing Persistent Disk resources to attach to each replica in the pool. Each disk will be attached in read-only mode to every replica.
- { # A pre-existing persistent disk that will be attached to every Replica in the Pool.
- "source": "A String", # The fully-qualified URL of the Persistent Disk resource. It must be in the same zone as the Pool.
- "attachment": { # How to attach a disk to a Replica. # Optional. How the disk will be attached to the Replica.
- "deviceName": "A String", # The device name of this disk.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
- },
- },
- ],
- "machineType": "A String", # The machine type for this instance. Either a complete URL, or the resource name (e.g. n1-standard-1).
- "baseInstanceName": "A String", # The base name for instances within this ReplicaPool.
- "initAction": "A String", # Name of the Action to be run during initialization of a ReplicaPoolModule.
- "networkInterfaces": [ # A list of network interfaces for the instance. Currently only one interface is supported by Google Compute Engine.
- { # A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource.
- "accessConfigs": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services
- { # A Compute Engine network accessConfig. Identical to the accessConfig on corresponding Compute Engine resource.
- "type": "A String", # Type of this access configuration file. (Currently only ONE_TO_ONE_NAT is legal.)
- "name": "A String", # Name of this access configuration.
- "natIp": "A String", # An external IP address associated with this instance.
- },
- ],
- "networkIp": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface.
- "name": "A String", # Name of the interface.
- "network": "A String", # The name of the NetworkModule to which this interface applies. If not specified, or specified as 'default', this will use the 'default' network.
- },
- ],
- "serviceAccounts": [ # A list of Service Accounts to enable for this instance.
- { # A Compute Engine service account, identical to the Compute Engine resource.
- "scopes": [ # List of OAuth2 scopes to obtain for the service account.
- "A String",
- ],
- "email": "A String", # Service account email address.
- },
- ],
- "metadata": { # A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource. # The metadata key/value pairs assigned to this instance.
- "items": [ # A list of metadata items.
- { # A Compute Engine metadata item, defined as a key:value pair. Identical to the metadata on the corresponding Compute Engine resource.
- "value": "A String", # A metadata value.
- "key": "A String", # A metadata key.
- },
- ],
- "fingerPrint": "A String", # The fingerprint of the metadata.
- },
- },
- },
- },
- "type": "A String", # The type of this module. Valid values ("AUTOSCALING", "FIREWALL", "HEALTH_CHECK", "LOAD_BALANCING", "NETWORK", "REPLICA_POOL")
- },
- },
- "description": "A String", # A user-supplied description of this Template.
- "actions": { # Action definitions for use in Module intents in this Template.
- "a_key": { # An Action encapsulates a set of commands as a single runnable module with additional information needed during run-time. # The name of this action, used when specifying Actions in Module definitions.
- "timeoutMs": 42, # The timeout in milliseconds for this action to run.
- "commands": [ # A list of commands to run sequentially for this action.
- "A String",
- ],
- },
- },
- "name": "A String", # Name of this Template. The name must conform to the expression: [a-zA-Z0-9-_]{1,64}
- }
-
-
-Returns:
- An object of the form:
-
- { # A Template represents a complete configuration for a Deployment.
- "modules": { # A list of modules for this Template.
- "a_key": { # A module in a configuration. A module represents a single homogeneous, possibly replicated task. # Name of the module. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
- "lbModule": {
- "description": "A String",
- "portRange": "A String",
- "sessionAffinity": "A String",
- "ipProtocol": "A String",
- "healthChecks": [
- "A String",
- ],
- "ipAddress": "A String",
- "targetModules": [
- "A String",
- ],
- },
- "networkModule": {
- "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.
- "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 typicall the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "description": "A String", # The description of the network.
- },
- "firewallModule": { # A Firewall resource
- "network": "A String", # The NetworkModule to which this firewall should apply. If not specified, or if specified as 'default', this firewall will be applied to the 'default' network.
- "sourceTags": [ # Source Tags to apply this firewall to, see the GCE Spec for details on syntax
- "A String",
- ],
- "sourceRanges": [ # Source IP ranges to apply this firewall to, see the GCE Spec for details on syntax
- "A String",
- ],
- "targetTags": [ # Target Tags to apply this firewall to, see the GCE Spec for details on syntax
- "A String",
- ],
- "allowed": [ # The allowed ports or port ranges.
- { # An allowed port resource.
- "IPProtocol": "A String", # ?tcp?, ?udp? or ?icmp?
- "ports": [ # List of ports or port ranges (Example inputs include: ["22"], [?33?, "12345-12349"].
- "A String",
- ],
- },
- ],
- "description": "A String", # The description of the firewall (optional)
- },
- "healthCheckModule": {
- "description": "A String",
- "timeoutSec": 42,
- "checkIntervalSec": 42,
- "unhealthyThreshold": 42,
- "healthyThreshold": 42,
- "host": "A String",
- "path": "A String",
- "port": 42,
- },
- "autoscalingModule": {
- "maxNumReplicas": 42,
- "description": "A String",
- "targetModule": "A String",
- "targetUtilization": 3.14, # target_utilization should be in range [0,1].
- "signalType": "A String",
- "coolDownPeriodSec": 42,
- "minNumReplicas": 42,
- },
- "replicaPoolModule": {
- "numReplicas": 42, # Number of replicas in this module.
- "healthChecks": [ # The Health Checks to configure for the ReplicaPoolModule
- "A String",
- ],
- "resourceView": "A String", # [Output Only] The name of the Resource View associated with a ReplicaPoolModule. This field will be generated by the service.
- "envVariables": { # A list of environment variables.
- "a_key": { # An environment variable. # Name of the environment variable. The name must conform to the following regular expression: [a-zA-Z_]+[a-zA-Z0-9_]+.
- "hidden": True or False, # Whether this variable is hidden or visible.
- "value": "A String", # Value of the environment variable.
- },
- },
- "replicaPoolParams": { # Configuration information for a ReplicaPools resource. Specifying an item within will determine the ReplicaPools API version used for a ReplicaPoolModule. Only one may be specified. # Information for a ReplicaPoolModule.
- "v1beta1": { # Configuration information for a ReplicaPools v1beta1 API resource. Directly maps to ReplicaPool InitTemplate. # ReplicaPoolParams specifications for use with ReplicaPools v1beta1.
- "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
- { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica.
- "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be <instance_name>-<five_random_charactersgt;.
- "diskSizeGb": "A String", # The size of the created disk in gigabytes.
- "sourceImage": "A String", # The fully-qualified URL of a source image to use to create this disk.
- "diskType": "A String", # Name of the disk type resource describing which disk type to use to create the disk. For example 'pd-ssd' or 'pd-standard'. Default is 'pd-standard'
- },
- "boot": True or False, # If true, indicates that this is the root persistent disk.
- "attachment": { # How to attach a disk to a Replica. # How the disk will be attached to the Replica.
- "deviceName": "A String", # The device name of this disk.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
- },
- "autoDelete": True or False, # If true, then this disk will be deleted when the instance is deleted.
- },
- ],
- "autoRestart": True or False, # Whether these replicas should be restarted if they experience a failure. The default value is true.
- "canIpForward": True or False, # Enables IP Forwarding
- "description": "A String", # An optional textual description of the resource.
- "zone": "A String", # The zone for this ReplicaPool.
- "tags": { # A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource. # A list of tags to apply to the Google Compute Engine instance to identify resources.
- "items": [ # Items contained in this tag.
- "A String",
- ],
- "fingerPrint": "A String", # The fingerprint of the tag.
- },
- "onHostMaintenance": "A String",
- "disksToAttach": [ # A list of existing Persistent Disk resources to attach to each replica in the pool. Each disk will be attached in read-only mode to every replica.
- { # A pre-existing persistent disk that will be attached to every Replica in the Pool.
- "source": "A String", # The fully-qualified URL of the Persistent Disk resource. It must be in the same zone as the Pool.
- "attachment": { # How to attach a disk to a Replica. # Optional. How the disk will be attached to the Replica.
- "deviceName": "A String", # The device name of this disk.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
- },
- },
- ],
- "machineType": "A String", # The machine type for this instance. Either a complete URL, or the resource name (e.g. n1-standard-1).
- "baseInstanceName": "A String", # The base name for instances within this ReplicaPool.
- "initAction": "A String", # Name of the Action to be run during initialization of a ReplicaPoolModule.
- "networkInterfaces": [ # A list of network interfaces for the instance. Currently only one interface is supported by Google Compute Engine.
- { # A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource.
- "accessConfigs": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services
- { # A Compute Engine network accessConfig. Identical to the accessConfig on corresponding Compute Engine resource.
- "type": "A String", # Type of this access configuration file. (Currently only ONE_TO_ONE_NAT is legal.)
- "name": "A String", # Name of this access configuration.
- "natIp": "A String", # An external IP address associated with this instance.
- },
- ],
- "networkIp": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface.
- "name": "A String", # Name of the interface.
- "network": "A String", # The name of the NetworkModule to which this interface applies. If not specified, or specified as 'default', this will use the 'default' network.
- },
- ],
- "serviceAccounts": [ # A list of Service Accounts to enable for this instance.
- { # A Compute Engine service account, identical to the Compute Engine resource.
- "scopes": [ # List of OAuth2 scopes to obtain for the service account.
- "A String",
- ],
- "email": "A String", # Service account email address.
- },
- ],
- "metadata": { # A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource. # The metadata key/value pairs assigned to this instance.
- "items": [ # A list of metadata items.
- { # A Compute Engine metadata item, defined as a key:value pair. Identical to the metadata on the corresponding Compute Engine resource.
- "value": "A String", # A metadata value.
- "key": "A String", # A metadata key.
- },
- ],
- "fingerPrint": "A String", # The fingerprint of the metadata.
- },
- },
- },
- },
- "type": "A String", # The type of this module. Valid values ("AUTOSCALING", "FIREWALL", "HEALTH_CHECK", "LOAD_BALANCING", "NETWORK", "REPLICA_POOL")
- },
- },
- "description": "A String", # A user-supplied description of this Template.
- "actions": { # Action definitions for use in Module intents in this Template.
- "a_key": { # An Action encapsulates a set of commands as a single runnable module with additional information needed during run-time. # The name of this action, used when specifying Actions in Module definitions.
- "timeoutMs": 42, # The timeout in milliseconds for this action to run.
- "commands": [ # A list of commands to run sequentially for this action.
- "A String",
- ],
- },
- },
- "name": "A String", # Name of this Template. The name must conform to the expression: [a-zA-Z0-9-_]{1,64}
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(projectId, pageToken=None, maxResults=None)</code>
- <pre>
-
-Args:
- projectId: string, A parameter (required)
- pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
- maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String",
- "resources": [
- { # A Template represents a complete configuration for a Deployment.
- "modules": { # A list of modules for this Template.
- "a_key": { # A module in a configuration. A module represents a single homogeneous, possibly replicated task. # Name of the module. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
- "lbModule": {
- "description": "A String",
- "portRange": "A String",
- "sessionAffinity": "A String",
- "ipProtocol": "A String",
- "healthChecks": [
- "A String",
- ],
- "ipAddress": "A String",
- "targetModules": [
- "A String",
- ],
- },
- "networkModule": {
- "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.
- "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 typicall the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "description": "A String", # The description of the network.
- },
- "firewallModule": { # A Firewall resource
- "network": "A String", # The NetworkModule to which this firewall should apply. If not specified, or if specified as 'default', this firewall will be applied to the 'default' network.
- "sourceTags": [ # Source Tags to apply this firewall to, see the GCE Spec for details on syntax
- "A String",
- ],
- "sourceRanges": [ # Source IP ranges to apply this firewall to, see the GCE Spec for details on syntax
- "A String",
- ],
- "targetTags": [ # Target Tags to apply this firewall to, see the GCE Spec for details on syntax
- "A String",
- ],
- "allowed": [ # The allowed ports or port ranges.
- { # An allowed port resource.
- "IPProtocol": "A String", # ?tcp?, ?udp? or ?icmp?
- "ports": [ # List of ports or port ranges (Example inputs include: ["22"], [?33?, "12345-12349"].
- "A String",
- ],
- },
- ],
- "description": "A String", # The description of the firewall (optional)
- },
- "healthCheckModule": {
- "description": "A String",
- "timeoutSec": 42,
- "checkIntervalSec": 42,
- "unhealthyThreshold": 42,
- "healthyThreshold": 42,
- "host": "A String",
- "path": "A String",
- "port": 42,
- },
- "autoscalingModule": {
- "maxNumReplicas": 42,
- "description": "A String",
- "targetModule": "A String",
- "targetUtilization": 3.14, # target_utilization should be in range [0,1].
- "signalType": "A String",
- "coolDownPeriodSec": 42,
- "minNumReplicas": 42,
- },
- "replicaPoolModule": {
- "numReplicas": 42, # Number of replicas in this module.
- "healthChecks": [ # The Health Checks to configure for the ReplicaPoolModule
- "A String",
- ],
- "resourceView": "A String", # [Output Only] The name of the Resource View associated with a ReplicaPoolModule. This field will be generated by the service.
- "envVariables": { # A list of environment variables.
- "a_key": { # An environment variable. # Name of the environment variable. The name must conform to the following regular expression: [a-zA-Z_]+[a-zA-Z0-9_]+.
- "hidden": True or False, # Whether this variable is hidden or visible.
- "value": "A String", # Value of the environment variable.
- },
- },
- "replicaPoolParams": { # Configuration information for a ReplicaPools resource. Specifying an item within will determine the ReplicaPools API version used for a ReplicaPoolModule. Only one may be specified. # Information for a ReplicaPoolModule.
- "v1beta1": { # Configuration information for a ReplicaPools v1beta1 API resource. Directly maps to ReplicaPool InitTemplate. # ReplicaPoolParams specifications for use with ReplicaPools v1beta1.
- "disksToCreate": [ # A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica.
- { # A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica.
- "initializeParams": { # Initialization parameters for creating a new disk. # Create the new disk using these parameters. The name of the disk will be <instance_name>-<five_random_charactersgt;.
- "diskSizeGb": "A String", # The size of the created disk in gigabytes.
- "sourceImage": "A String", # The fully-qualified URL of a source image to use to create this disk.
- "diskType": "A String", # Name of the disk type resource describing which disk type to use to create the disk. For example 'pd-ssd' or 'pd-standard'. Default is 'pd-standard'
- },
- "boot": True or False, # If true, indicates that this is the root persistent disk.
- "attachment": { # How to attach a disk to a Replica. # How the disk will be attached to the Replica.
- "deviceName": "A String", # The device name of this disk.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
- },
- "autoDelete": True or False, # If true, then this disk will be deleted when the instance is deleted.
- },
- ],
- "autoRestart": True or False, # Whether these replicas should be restarted if they experience a failure. The default value is true.
- "canIpForward": True or False, # Enables IP Forwarding
- "description": "A String", # An optional textual description of the resource.
- "zone": "A String", # The zone for this ReplicaPool.
- "tags": { # A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource. # A list of tags to apply to the Google Compute Engine instance to identify resources.
- "items": [ # Items contained in this tag.
- "A String",
- ],
- "fingerPrint": "A String", # The fingerprint of the tag.
- },
- "onHostMaintenance": "A String",
- "disksToAttach": [ # A list of existing Persistent Disk resources to attach to each replica in the pool. Each disk will be attached in read-only mode to every replica.
- { # A pre-existing persistent disk that will be attached to every Replica in the Pool.
- "source": "A String", # The fully-qualified URL of the Persistent Disk resource. It must be in the same zone as the Pool.
- "attachment": { # How to attach a disk to a Replica. # Optional. How the disk will be attached to the Replica.
- "deviceName": "A String", # The device name of this disk.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server.
- },
- },
- ],
- "machineType": "A String", # The machine type for this instance. Either a complete URL, or the resource name (e.g. n1-standard-1).
- "baseInstanceName": "A String", # The base name for instances within this ReplicaPool.
- "initAction": "A String", # Name of the Action to be run during initialization of a ReplicaPoolModule.
- "networkInterfaces": [ # A list of network interfaces for the instance. Currently only one interface is supported by Google Compute Engine.
- { # A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource.
- "accessConfigs": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services
- { # A Compute Engine network accessConfig. Identical to the accessConfig on corresponding Compute Engine resource.
- "type": "A String", # Type of this access configuration file. (Currently only ONE_TO_ONE_NAT is legal.)
- "name": "A String", # Name of this access configuration.
- "natIp": "A String", # An external IP address associated with this instance.
- },
- ],
- "networkIp": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface.
- "name": "A String", # Name of the interface.
- "network": "A String", # The name of the NetworkModule to which this interface applies. If not specified, or specified as 'default', this will use the 'default' network.
- },
- ],
- "serviceAccounts": [ # A list of Service Accounts to enable for this instance.
- { # A Compute Engine service account, identical to the Compute Engine resource.
- "scopes": [ # List of OAuth2 scopes to obtain for the service account.
- "A String",
- ],
- "email": "A String", # Service account email address.
- },
- ],
- "metadata": { # A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource. # The metadata key/value pairs assigned to this instance.
- "items": [ # A list of metadata items.
- { # A Compute Engine metadata item, defined as a key:value pair. Identical to the metadata on the corresponding Compute Engine resource.
- "value": "A String", # A metadata value.
- "key": "A String", # A metadata key.
- },
- ],
- "fingerPrint": "A String", # The fingerprint of the metadata.
- },
- },
- },
- },
- "type": "A String", # The type of this module. Valid values ("AUTOSCALING", "FIREWALL", "HEALTH_CHECK", "LOAD_BALANCING", "NETWORK", "REPLICA_POOL")
- },
- },
- "description": "A String", # A user-supplied description of this Template.
- "actions": { # Action definitions for use in Module intents in this Template.
- "a_key": { # An Action encapsulates a set of commands as a single runnable module with additional information needed during run-time. # The name of this action, used when specifying Actions in Module definitions.
- "timeoutMs": 42, # The timeout in milliseconds for this action to run.
- "commands": [ # A list of commands to run sequentially for this action.
- "A String",
- ],
- },
- },
- "name": "A String", # Name of this Template. The name must conform to the expression: [a-zA-Z0-9-_]{1,64}
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.assets.html b/docs/dyn/mapsengine_v1.assets.html
deleted file mode 100644
index 3e32482..0000000
--- a/docs/dyn/mapsengine_v1.assets.html
+++ /dev/null
@@ -1,200 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.assets.html">assets</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="mapsengine_v1.assets.parents.html">parents()</a></code>
-</p>
-<p class="firstline">Returns the parents Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.assets.permissions.html">permissions()</a></code>
-</p>
-<p class="firstline">Returns the permissions Resource.</p>
-
-<p class="toc_element">
- <code><a href="#get">get(id)</a></code></p>
-<p class="firstline">Return metadata for a particular asset.</p>
-<p class="toc_element">
- <code><a href="#list">list(modifiedBefore=None, creatorEmail=None, projectId=None, pageToken=None, role=None, type=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</a></code></p>
-<p class="firstline">Return all assets readable by the current user.</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(id)</code>
- <pre>Return metadata for a particular asset.
-
-Args:
- id: string, The ID of the asset. (required)
-
-Returns:
- An object of the form:
-
- { # An asset is any Google Maps Engine resource that has a globally unique ID. Assets include maps, layers, vector tables, raster collections, and rasters. Projects and features are not considered assets.
- #
- # More detailed information about an asset can be obtained by querying the asset's particular endpoint.
- "resource": "A String", # The URL to query to retrieve the asset's complete object. The assets endpoint only returns high-level information about a resource.
- "description": "A String", # The asset's description.
- "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
- "A String",
- ],
- "projectId": "A String", # The ID of the project to which the asset belongs.
- "creationTime": "A String", # The creation time of this asset. The value is an RFC 3339-formatted date-time value (for example, 1970-01-01T00:00:00Z).
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this asset. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this asset. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this asset. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this asset. The value is an RFC 3339-formatted date-time value (for example, 1970-01-01T00:00:00Z).
- "type": "A String", # The type of asset. One of raster, rasterCollection, table, map, or layer.
- "id": "A String", # The asset's globally unique ID.
- "name": "A String", # The asset's name.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(modifiedBefore=None, creatorEmail=None, projectId=None, pageToken=None, role=None, type=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</code>
- <pre>Return all assets readable by the current user.
-
-Args:
- modifiedBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.
- creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
- projectId: string, The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
- Allowed values
- owner - The user can read, write and administer the asset.
- reader - The user can read the asset.
- writer - The user can read and write the asset.
- type: string, A comma separated list of asset types. Returned assets will have one of the types from the provided list. Supported values are 'map', 'layer', 'rasterCollection' and 'table'.
- createdAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.
- tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
- bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
- modifiedAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.
- search: string, An unstructured search string used to filter the set of results based on asset metadata.
- createdBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to resources.List.
- "nextPageToken": "A String", # Next page token.
- "assets": [ # Assets returned.
- { # An asset is any Google Maps Engine resource that has a globally unique ID. Assets include maps, layers, vector tables, raster collections, and rasters. Projects and features are not considered assets.
- #
- # More detailed information about an asset can be obtained by querying the asset's particular endpoint.
- "resource": "A String", # The URL to query to retrieve the asset's complete object. The assets endpoint only returns high-level information about a resource.
- "description": "A String", # The asset's description.
- "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
- "A String",
- ],
- "projectId": "A String", # The ID of the project to which the asset belongs.
- "creationTime": "A String", # The creation time of this asset. The value is an RFC 3339-formatted date-time value (for example, 1970-01-01T00:00:00Z).
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this asset. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this asset. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this asset. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this asset. The value is an RFC 3339-formatted date-time value (for example, 1970-01-01T00:00:00Z).
- "type": "A String", # The type of asset. One of raster, rasterCollection, table, map, or layer.
- "id": "A String", # The asset's globally unique ID.
- "name": "A String", # The asset's name.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.assets.parents.html b/docs/dyn/mapsengine_v1.assets.parents.html
deleted file mode 100644
index bd98ae6..0000000
--- a/docs/dyn/mapsengine_v1.assets.parents.html
+++ /dev/null
@@ -1,120 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.assets.html">assets</a> . <a href="mapsengine_v1.assets.parents.html">parents</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(id, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Return all parent ids of the specified asset.</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(id, pageToken=None, maxResults=None)</code>
- <pre>Return all parent ids of the specified asset.
-
-Args:
- id: string, The ID of the asset whose parents will be listed. (required)
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 50.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to parents.List.
- "nextPageToken": "A String", # Next page token.
- "parents": [ # The parent assets.
- { # A list of the parents of an asset.
- "id": "A String", # The ID of this parent.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.assets.permissions.html b/docs/dyn/mapsengine_v1.assets.permissions.html
deleted file mode 100644
index 04d3ff0..0000000
--- a/docs/dyn/mapsengine_v1.assets.permissions.html
+++ /dev/null
@@ -1,103 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.assets.html">assets</a> . <a href="mapsengine_v1.assets.permissions.html">permissions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(id)</a></code></p>
-<p class="firstline">Return all of the permissions for the specified asset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(id)</code>
- <pre>Return all of the permissions for the specified asset.
-
-Args:
- id: string, The ID of the asset whose permissions will be listed. (required)
-
-Returns:
- An object of the form:
-
- {
- "permissions": [ # The set of permissions associated with this asset.
- { # A permission defines the user or group that has access to an asset, and the type of access they have.
- "type": "A String", # The account type.
- "role": "A String", # The type of access granted to this user or group.
- "discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
- "id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.html b/docs/dyn/mapsengine_v1.html
deleted file mode 100644
index f75bdf8..0000000
--- a/docs/dyn/mapsengine_v1.html
+++ /dev/null
@@ -1,133 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="mapsengine_v1.assets.html">assets()</a></code>
-</p>
-<p class="firstline">Returns the assets Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.layers.html">layers()</a></code>
-</p>
-<p class="firstline">Returns the layers Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.maps.html">maps()</a></code>
-</p>
-<p class="firstline">Returns the maps Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.projects.html">projects()</a></code>
-</p>
-<p class="firstline">Returns the projects Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.rasterCollections.html">rasterCollections()</a></code>
-</p>
-<p class="firstline">Returns the rasterCollections Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.rasters.html">rasters()</a></code>
-</p>
-<p class="firstline">Returns the rasters Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.tables.html">tables()</a></code>
-</p>
-<p class="firstline">Returns the tables Resource.</p>
-
-<p class="toc_element">
- <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
-<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
- <pre>Create a BatchHttpRequest object based on the discovery document.
-
- Args:
- callback: callable, A callback to be called for each response, of the
- form callback(id, response, exception). The first parameter is the
- request id, and the second is the deserialized response object. The
- third is an apiclient.errors.HttpError exception object if an HTTP
- error occurred while processing the request, or None if no error
- occurred.
-
- Returns:
- A BatchHttpRequest object based on the discovery document.
- </pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.layers.html b/docs/dyn/mapsengine_v1.layers.html
deleted file mode 100644
index cc1403a..0000000
--- a/docs/dyn/mapsengine_v1.layers.html
+++ /dev/null
@@ -1,1065 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.layers.html">layers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="mapsengine_v1.layers.parents.html">parents()</a></code>
-</p>
-<p class="firstline">Returns the parents Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.layers.permissions.html">permissions()</a></code>
-</p>
-<p class="firstline">Returns the permissions Resource.</p>
-
-<p class="toc_element">
- <code><a href="#cancelProcessing">cancelProcessing(id)</a></code></p>
-<p class="firstline">Cancel processing on a layer asset.</p>
-<p class="toc_element">
- <code><a href="#create">create(body, process=None)</a></code></p>
-<p class="firstline">Create a layer asset.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(id)</a></code></p>
-<p class="firstline">Delete a layer.</p>
-<p class="toc_element">
- <code><a href="#get">get(id, version=None)</a></code></p>
-<p class="firstline">Return metadata for a particular layer.</p>
-<p class="toc_element">
- <code><a href="#getPublished">getPublished(id)</a></code></p>
-<p class="firstline">Return the published metadata for a particular layer.</p>
-<p class="toc_element">
- <code><a href="#list">list(modifiedBefore=None, creatorEmail=None, processingStatus=None, projectId=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</a></code></p>
-<p class="firstline">Return all layers readable by the current user.</p>
-<p class="toc_element">
- <code><a href="#listPublished">listPublished(pageToken=None, maxResults=None, projectId=None)</a></code></p>
-<p class="firstline">Return all published layers readable by the current user.</p>
-<p class="toc_element">
- <code><a href="#listPublished_next">listPublished_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="#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(id, body)</a></code></p>
-<p class="firstline">Mutate a layer asset.</p>
-<p class="toc_element">
- <code><a href="#process">process(id)</a></code></p>
-<p class="firstline">Process a layer asset.</p>
-<p class="toc_element">
- <code><a href="#publish">publish(id, force=None)</a></code></p>
-<p class="firstline">Publish a layer asset.</p>
-<p class="toc_element">
- <code><a href="#unpublish">unpublish(id)</a></code></p>
-<p class="firstline">Unpublish a layer asset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="cancelProcessing">cancelProcessing(id)</code>
- <pre>Cancel processing on a layer asset.
-
-Args:
- id: string, The ID of the layer. (required)
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to any asset's Process method.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="create">create(body, process=None)</code>
- <pre>Create a layer asset.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Layer combines multiple datasources, with styling information, for presentation on a map.
- "style": { # A vector style contains styling information for vector layer. # The styling information for a vector layer. Note: Style information is returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the VectorStyles for each layer.
- "featureInfo": { # A feature info contains information about individual feature. # Individual feature info, this is called Info Window in Maps Engine UI. If not provided, a default template with all attributes will be generated.
- "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
- },
- "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
- "displayRules": [
- { # A display rule of the vector style.
- "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
- "label": { # Text label style. # Label style for the point.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one of 'name', 'id' or 'scaledShape' must be set.
- "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
- "column": "A String", # Name of the numeric column used to scale a shape.
- "valueRange": { # Range of values used for scaling shapes. The min/max values will be drawn as shapes with the min/max size. # The range of values to display across the size range.
- "max": 3.14, # Maximum value.
- "min": 3.14, # Minimum value.
- },
- "sizeRange": { # Scaled shape size range in pixels. For circles, size corresponds to diameter. # The range of shape sizes, in pixels. For circles, the size corresponds to the diameter.
- "max": 3.14, # Maximum size, in pixels.
- "min": 3.14, # Minimum size, in pixels.
- },
- "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
- },
- "id": "A String", # Custom icon id.
- "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
- "shape": "A String", # Name of the shape.
- "border": { # Border in line style. Both color and width are required. # Border color/width of the shape. If not specified the shape won't have a border.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "fill": { # Basic color used in styling. # The fill color of the shape. If not specified the shape will be transparent (although the borders may not be).
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- },
- "name": "A String", # Stock icon name. To use a stock icon, prefix it with 'gx_'. See Stock icon names for valid icon names. For example, to specify small_red, set name to 'gx_small_red'.
- },
- },
- "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
- "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
- "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "label": { # Text label style. # Label style for the polygon.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- "fill": { # Basic color used in styling. # Fill color of the polygon. If not provided, the polygon will be transparent and not visible if there is no border.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- },
- "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
- "dash": [ # Dash defines the pattern of the line, the values are pixel lengths of alternating dash and gap. If dash is not provided, then it means a solid line. Dash can contain up to 10 values and must contain even number of values.
- 3.14,
- ],
- "stroke": { # Stroke of the line.
- "color": "A String", # Color of the line.
- "opacity": 3.14, # Opacity of the line.
- "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
- },
- "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "label": { # Text label style. # Label style for the line.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- },
- "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
- "max": 42, # Maximum zoom level.
- "min": 42, # Minimum zoom level.
- },
- "filters": [ # This display rule will only be applied to features that match all of the filters here. If filters is empty, then the rule applies to all features.
- { # Conditions for filtering features.
- "column": "A String", # The column name to filter on.
- "operator": "A String", # Operation used to evaluate the filter.
- "value": "", # Value to be evaluated against attribute.
- },
- ],
- },
- ],
- },
- "datasources": [ # An array of datasources used to build this layer. If layerType is "image", or layerType is not specified and datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If layerType is "vector", or layerType is not specified and datasourceType is "table" then each element in this array is a reference to a Vector Table.
- {
- "id": "A String", # The ID of a datasource.
- },
- ],
- "processingStatus": "A String", # The processing status of this layer.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "datasourceType": "A String", # Deprecated: The type of the datasources used to build this Layer. Note: This has been replaced by layerType, but is still available for now to maintain backward compatibility.
- "tags": [ # Tags of this Layer.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishingStatus": "A String", # The publishing status of this layer.
- "name": "A String", # The name of this Layer, supplied by the author.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
- "projectId": "A String", # The ID of the project that this Layer is in.
- "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this Layer.
- "description": "A String", # The description of this Layer, supplied by the author.
-}
-
- process: boolean, Whether to queue the created layer for processing.
-
-Returns:
- An object of the form:
-
- { # A Layer combines multiple datasources, with styling information, for presentation on a map.
- "style": { # A vector style contains styling information for vector layer. # The styling information for a vector layer. Note: Style information is returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the VectorStyles for each layer.
- "featureInfo": { # A feature info contains information about individual feature. # Individual feature info, this is called Info Window in Maps Engine UI. If not provided, a default template with all attributes will be generated.
- "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
- },
- "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
- "displayRules": [
- { # A display rule of the vector style.
- "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
- "label": { # Text label style. # Label style for the point.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one of 'name', 'id' or 'scaledShape' must be set.
- "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
- "column": "A String", # Name of the numeric column used to scale a shape.
- "valueRange": { # Range of values used for scaling shapes. The min/max values will be drawn as shapes with the min/max size. # The range of values to display across the size range.
- "max": 3.14, # Maximum value.
- "min": 3.14, # Minimum value.
- },
- "sizeRange": { # Scaled shape size range in pixels. For circles, size corresponds to diameter. # The range of shape sizes, in pixels. For circles, the size corresponds to the diameter.
- "max": 3.14, # Maximum size, in pixels.
- "min": 3.14, # Minimum size, in pixels.
- },
- "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
- },
- "id": "A String", # Custom icon id.
- "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
- "shape": "A String", # Name of the shape.
- "border": { # Border in line style. Both color and width are required. # Border color/width of the shape. If not specified the shape won't have a border.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "fill": { # Basic color used in styling. # The fill color of the shape. If not specified the shape will be transparent (although the borders may not be).
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- },
- "name": "A String", # Stock icon name. To use a stock icon, prefix it with 'gx_'. See Stock icon names for valid icon names. For example, to specify small_red, set name to 'gx_small_red'.
- },
- },
- "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
- "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
- "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "label": { # Text label style. # Label style for the polygon.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- "fill": { # Basic color used in styling. # Fill color of the polygon. If not provided, the polygon will be transparent and not visible if there is no border.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- },
- "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
- "dash": [ # Dash defines the pattern of the line, the values are pixel lengths of alternating dash and gap. If dash is not provided, then it means a solid line. Dash can contain up to 10 values and must contain even number of values.
- 3.14,
- ],
- "stroke": { # Stroke of the line.
- "color": "A String", # Color of the line.
- "opacity": 3.14, # Opacity of the line.
- "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
- },
- "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "label": { # Text label style. # Label style for the line.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- },
- "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
- "max": 42, # Maximum zoom level.
- "min": 42, # Minimum zoom level.
- },
- "filters": [ # This display rule will only be applied to features that match all of the filters here. If filters is empty, then the rule applies to all features.
- { # Conditions for filtering features.
- "column": "A String", # The column name to filter on.
- "operator": "A String", # Operation used to evaluate the filter.
- "value": "", # Value to be evaluated against attribute.
- },
- ],
- },
- ],
- },
- "datasources": [ # An array of datasources used to build this layer. If layerType is "image", or layerType is not specified and datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If layerType is "vector", or layerType is not specified and datasourceType is "table" then each element in this array is a reference to a Vector Table.
- {
- "id": "A String", # The ID of a datasource.
- },
- ],
- "processingStatus": "A String", # The processing status of this layer.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "datasourceType": "A String", # Deprecated: The type of the datasources used to build this Layer. Note: This has been replaced by layerType, but is still available for now to maintain backward compatibility.
- "tags": [ # Tags of this Layer.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishingStatus": "A String", # The publishing status of this layer.
- "name": "A String", # The name of this Layer, supplied by the author.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
- "projectId": "A String", # The ID of the project that this Layer is in.
- "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this Layer.
- "description": "A String", # The description of this Layer, supplied by the author.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(id)</code>
- <pre>Delete a layer.
-
-Args:
- id: string, The ID of the layer. Only the layer creator or project owner are permitted to delete. If the layer is published, or included in a map, the request will fail. Unpublish the layer, and remove it from all maps prior to deleting. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(id, version=None)</code>
- <pre>Return metadata for a particular layer.
-
-Args:
- id: string, The ID of the layer. (required)
- version: string, Deprecated: The version parameter indicates which version of the layer should be returned. When version is set to published, the published version of the layer will be returned. Please use the layers.getPublished endpoint instead.
- Allowed values
- draft - The draft version.
- published - The published version.
-
-Returns:
- An object of the form:
-
- { # A Layer combines multiple datasources, with styling information, for presentation on a map.
- "style": { # A vector style contains styling information for vector layer. # The styling information for a vector layer. Note: Style information is returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the VectorStyles for each layer.
- "featureInfo": { # A feature info contains information about individual feature. # Individual feature info, this is called Info Window in Maps Engine UI. If not provided, a default template with all attributes will be generated.
- "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
- },
- "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
- "displayRules": [
- { # A display rule of the vector style.
- "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
- "label": { # Text label style. # Label style for the point.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one of 'name', 'id' or 'scaledShape' must be set.
- "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
- "column": "A String", # Name of the numeric column used to scale a shape.
- "valueRange": { # Range of values used for scaling shapes. The min/max values will be drawn as shapes with the min/max size. # The range of values to display across the size range.
- "max": 3.14, # Maximum value.
- "min": 3.14, # Minimum value.
- },
- "sizeRange": { # Scaled shape size range in pixels. For circles, size corresponds to diameter. # The range of shape sizes, in pixels. For circles, the size corresponds to the diameter.
- "max": 3.14, # Maximum size, in pixels.
- "min": 3.14, # Minimum size, in pixels.
- },
- "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
- },
- "id": "A String", # Custom icon id.
- "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
- "shape": "A String", # Name of the shape.
- "border": { # Border in line style. Both color and width are required. # Border color/width of the shape. If not specified the shape won't have a border.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "fill": { # Basic color used in styling. # The fill color of the shape. If not specified the shape will be transparent (although the borders may not be).
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- },
- "name": "A String", # Stock icon name. To use a stock icon, prefix it with 'gx_'. See Stock icon names for valid icon names. For example, to specify small_red, set name to 'gx_small_red'.
- },
- },
- "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
- "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
- "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "label": { # Text label style. # Label style for the polygon.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- "fill": { # Basic color used in styling. # Fill color of the polygon. If not provided, the polygon will be transparent and not visible if there is no border.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- },
- "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
- "dash": [ # Dash defines the pattern of the line, the values are pixel lengths of alternating dash and gap. If dash is not provided, then it means a solid line. Dash can contain up to 10 values and must contain even number of values.
- 3.14,
- ],
- "stroke": { # Stroke of the line.
- "color": "A String", # Color of the line.
- "opacity": 3.14, # Opacity of the line.
- "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
- },
- "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "label": { # Text label style. # Label style for the line.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- },
- "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
- "max": 42, # Maximum zoom level.
- "min": 42, # Minimum zoom level.
- },
- "filters": [ # This display rule will only be applied to features that match all of the filters here. If filters is empty, then the rule applies to all features.
- { # Conditions for filtering features.
- "column": "A String", # The column name to filter on.
- "operator": "A String", # Operation used to evaluate the filter.
- "value": "", # Value to be evaluated against attribute.
- },
- ],
- },
- ],
- },
- "datasources": [ # An array of datasources used to build this layer. If layerType is "image", or layerType is not specified and datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If layerType is "vector", or layerType is not specified and datasourceType is "table" then each element in this array is a reference to a Vector Table.
- {
- "id": "A String", # The ID of a datasource.
- },
- ],
- "processingStatus": "A String", # The processing status of this layer.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "datasourceType": "A String", # Deprecated: The type of the datasources used to build this Layer. Note: This has been replaced by layerType, but is still available for now to maintain backward compatibility.
- "tags": [ # Tags of this Layer.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishingStatus": "A String", # The publishing status of this layer.
- "name": "A String", # The name of this Layer, supplied by the author.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
- "projectId": "A String", # The ID of the project that this Layer is in.
- "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this Layer.
- "description": "A String", # The description of this Layer, supplied by the author.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="getPublished">getPublished(id)</code>
- <pre>Return the published metadata for a particular layer.
-
-Args:
- id: string, The ID of the layer. (required)
-
-Returns:
- An object of the form:
-
- { # The published version of a layer.
- "projectId": "A String", # The ID of the project that this Layer is in.
- "name": "A String", # The name of this Layer, supplied by the author.
- "description": "A String", # The description of this Layer, supplied by the author.
- "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
- "id": "A String", # A globally unique ID, used to refer to this Layer.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(modifiedBefore=None, creatorEmail=None, processingStatus=None, projectId=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</code>
- <pre>Return all layers readable by the current user.
-
-Args:
- modifiedBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.
- creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
- processingStatus: string, A parameter
- Allowed values
- complete - The layer has completed processing.
- failed - The layer has failed processing.
- notReady - The layer is not ready for processing.
- processing - The layer is processing.
- ready - The layer is ready for processing.
- projectId: string, The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
- Allowed values
- owner - The user can read, write and administer the asset.
- reader - The user can read the asset.
- writer - The user can read and write the asset.
- createdAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.
- tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
- bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
- modifiedAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.
- search: string, An unstructured search string used to filter the set of results based on asset metadata.
- createdBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to layers.List. Note: The list response does not include all the fields available in a layer. Refer to the layer resource description for details of the fields that are not included. You'll need to send a get request to retrieve the additional fields for each layer.
- "layers": [ # Resources returned.
- { # A Layer combines multiple datasources, with styling information, for presentation on a map.
- "style": { # A vector style contains styling information for vector layer. # The styling information for a vector layer. Note: Style information is returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the VectorStyles for each layer.
- "featureInfo": { # A feature info contains information about individual feature. # Individual feature info, this is called Info Window in Maps Engine UI. If not provided, a default template with all attributes will be generated.
- "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
- },
- "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
- "displayRules": [
- { # A display rule of the vector style.
- "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
- "label": { # Text label style. # Label style for the point.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one of 'name', 'id' or 'scaledShape' must be set.
- "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
- "column": "A String", # Name of the numeric column used to scale a shape.
- "valueRange": { # Range of values used for scaling shapes. The min/max values will be drawn as shapes with the min/max size. # The range of values to display across the size range.
- "max": 3.14, # Maximum value.
- "min": 3.14, # Minimum value.
- },
- "sizeRange": { # Scaled shape size range in pixels. For circles, size corresponds to diameter. # The range of shape sizes, in pixels. For circles, the size corresponds to the diameter.
- "max": 3.14, # Maximum size, in pixels.
- "min": 3.14, # Minimum size, in pixels.
- },
- "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
- },
- "id": "A String", # Custom icon id.
- "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
- "shape": "A String", # Name of the shape.
- "border": { # Border in line style. Both color and width are required. # Border color/width of the shape. If not specified the shape won't have a border.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "fill": { # Basic color used in styling. # The fill color of the shape. If not specified the shape will be transparent (although the borders may not be).
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- },
- "name": "A String", # Stock icon name. To use a stock icon, prefix it with 'gx_'. See Stock icon names for valid icon names. For example, to specify small_red, set name to 'gx_small_red'.
- },
- },
- "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
- "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
- "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "label": { # Text label style. # Label style for the polygon.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- "fill": { # Basic color used in styling. # Fill color of the polygon. If not provided, the polygon will be transparent and not visible if there is no border.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- },
- "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
- "dash": [ # Dash defines the pattern of the line, the values are pixel lengths of alternating dash and gap. If dash is not provided, then it means a solid line. Dash can contain up to 10 values and must contain even number of values.
- 3.14,
- ],
- "stroke": { # Stroke of the line.
- "color": "A String", # Color of the line.
- "opacity": 3.14, # Opacity of the line.
- "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
- },
- "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "label": { # Text label style. # Label style for the line.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- },
- "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
- "max": 42, # Maximum zoom level.
- "min": 42, # Minimum zoom level.
- },
- "filters": [ # This display rule will only be applied to features that match all of the filters here. If filters is empty, then the rule applies to all features.
- { # Conditions for filtering features.
- "column": "A String", # The column name to filter on.
- "operator": "A String", # Operation used to evaluate the filter.
- "value": "", # Value to be evaluated against attribute.
- },
- ],
- },
- ],
- },
- "datasources": [ # An array of datasources used to build this layer. If layerType is "image", or layerType is not specified and datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If layerType is "vector", or layerType is not specified and datasourceType is "table" then each element in this array is a reference to a Vector Table.
- {
- "id": "A String", # The ID of a datasource.
- },
- ],
- "processingStatus": "A String", # The processing status of this layer.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "datasourceType": "A String", # Deprecated: The type of the datasources used to build this Layer. Note: This has been replaced by layerType, but is still available for now to maintain backward compatibility.
- "tags": [ # Tags of this Layer.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishingStatus": "A String", # The publishing status of this layer.
- "name": "A String", # The name of this Layer, supplied by the author.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
- "projectId": "A String", # The ID of the project that this Layer is in.
- "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this Layer.
- "description": "A String", # The description of this Layer, supplied by the author.
- },
- ],
- "nextPageToken": "A String", # Next page token.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="listPublished">listPublished(pageToken=None, maxResults=None, projectId=None)</code>
- <pre>Return all published layers readable by the current user.
-
-Args:
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
- projectId: string, The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to layers.List.published.
- "layers": [ # Resources returned.
- { # The published version of a layer.
- "projectId": "A String", # The ID of the project that this Layer is in.
- "name": "A String", # The name of this Layer, supplied by the author.
- "description": "A String", # The description of this Layer, supplied by the author.
- "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
- "id": "A String", # A globally unique ID, used to refer to this Layer.
- },
- ],
- "nextPageToken": "A String", # Next page token.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="listPublished_next">listPublished_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="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(id, body)</code>
- <pre>Mutate a layer asset.
-
-Args:
- id: string, The ID of the layer. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Layer combines multiple datasources, with styling information, for presentation on a map.
- "style": { # A vector style contains styling information for vector layer. # The styling information for a vector layer. Note: Style information is returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the VectorStyles for each layer.
- "featureInfo": { # A feature info contains information about individual feature. # Individual feature info, this is called Info Window in Maps Engine UI. If not provided, a default template with all attributes will be generated.
- "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
- },
- "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
- "displayRules": [
- { # A display rule of the vector style.
- "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
- "label": { # Text label style. # Label style for the point.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one of 'name', 'id' or 'scaledShape' must be set.
- "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
- "column": "A String", # Name of the numeric column used to scale a shape.
- "valueRange": { # Range of values used for scaling shapes. The min/max values will be drawn as shapes with the min/max size. # The range of values to display across the size range.
- "max": 3.14, # Maximum value.
- "min": 3.14, # Minimum value.
- },
- "sizeRange": { # Scaled shape size range in pixels. For circles, size corresponds to diameter. # The range of shape sizes, in pixels. For circles, the size corresponds to the diameter.
- "max": 3.14, # Maximum size, in pixels.
- "min": 3.14, # Minimum size, in pixels.
- },
- "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
- },
- "id": "A String", # Custom icon id.
- "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
- "shape": "A String", # Name of the shape.
- "border": { # Border in line style. Both color and width are required. # Border color/width of the shape. If not specified the shape won't have a border.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "fill": { # Basic color used in styling. # The fill color of the shape. If not specified the shape will be transparent (although the borders may not be).
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- },
- "name": "A String", # Stock icon name. To use a stock icon, prefix it with 'gx_'. See Stock icon names for valid icon names. For example, to specify small_red, set name to 'gx_small_red'.
- },
- },
- "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
- "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
- "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "label": { # Text label style. # Label style for the polygon.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- "fill": { # Basic color used in styling. # Fill color of the polygon. If not provided, the polygon will be transparent and not visible if there is no border.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- },
- "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
- "dash": [ # Dash defines the pattern of the line, the values are pixel lengths of alternating dash and gap. If dash is not provided, then it means a solid line. Dash can contain up to 10 values and must contain even number of values.
- 3.14,
- ],
- "stroke": { # Stroke of the line.
- "color": "A String", # Color of the line.
- "opacity": 3.14, # Opacity of the line.
- "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
- },
- "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
- "color": "A String", # Color of the border.
- "opacity": 3.14, # Opacity of the border.
- "width": 3.14, # Width of the border, in pixels.
- },
- "label": { # Text label style. # Label style for the line.
- "opacity": 3.14, # Opacity of the text.
- "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
- "outline": { # Basic color used in styling. # Outline color of the text.
- "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
- "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
- },
- "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
- "color": "A String", # Color of the text. If not provided, default to black.
- "column": "A String", # The column value of the feature to be displayed.
- "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
- },
- },
- "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
- "max": 42, # Maximum zoom level.
- "min": 42, # Minimum zoom level.
- },
- "filters": [ # This display rule will only be applied to features that match all of the filters here. If filters is empty, then the rule applies to all features.
- { # Conditions for filtering features.
- "column": "A String", # The column name to filter on.
- "operator": "A String", # Operation used to evaluate the filter.
- "value": "", # Value to be evaluated against attribute.
- },
- ],
- },
- ],
- },
- "datasources": [ # An array of datasources used to build this layer. If layerType is "image", or layerType is not specified and datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If layerType is "vector", or layerType is not specified and datasourceType is "table" then each element in this array is a reference to a Vector Table.
- {
- "id": "A String", # The ID of a datasource.
- },
- ],
- "processingStatus": "A String", # The processing status of this layer.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "datasourceType": "A String", # Deprecated: The type of the datasources used to build this Layer. Note: This has been replaced by layerType, but is still available for now to maintain backward compatibility.
- "tags": [ # Tags of this Layer.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishingStatus": "A String", # The publishing status of this layer.
- "name": "A String", # The name of this Layer, supplied by the author.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
- "projectId": "A String", # The ID of the project that this Layer is in.
- "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this Layer.
- "description": "A String", # The description of this Layer, supplied by the author.
-}
-
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="process">process(id)</code>
- <pre>Process a layer asset.
-
-Args:
- id: string, The ID of the layer. (required)
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to any asset's Process method.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="publish">publish(id, force=None)</code>
- <pre>Publish a layer asset.
-
-Args:
- id: string, The ID of the layer. (required)
- force: boolean, If set to true, the API will allow publication of the layer even if it's out of date. If not true, you'll need to reprocess any out-of-date layer before publishing.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to any asset's Publish method.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="unpublish">unpublish(id)</code>
- <pre>Unpublish a layer asset.
-
-Args:
- id: string, The ID of the layer. (required)
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to any asset's Publish method.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.layers.parents.html b/docs/dyn/mapsengine_v1.layers.parents.html
deleted file mode 100644
index c34035b..0000000
--- a/docs/dyn/mapsengine_v1.layers.parents.html
+++ /dev/null
@@ -1,120 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.layers.html">layers</a> . <a href="mapsengine_v1.layers.parents.html">parents</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(id, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Return all parent ids of the specified layer.</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(id, pageToken=None, maxResults=None)</code>
- <pre>Return all parent ids of the specified layer.
-
-Args:
- id: string, The ID of the layer whose parents will be listed. (required)
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 50.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to parents.List.
- "nextPageToken": "A String", # Next page token.
- "parents": [ # The parent assets.
- { # A list of the parents of an asset.
- "id": "A String", # The ID of this parent.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.layers.permissions.html b/docs/dyn/mapsengine_v1.layers.permissions.html
deleted file mode 100644
index bd78562..0000000
--- a/docs/dyn/mapsengine_v1.layers.permissions.html
+++ /dev/null
@@ -1,162 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.layers.html">layers</a> . <a href="mapsengine_v1.layers.permissions.html">permissions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#batchDelete">batchDelete(id, body)</a></code></p>
-<p class="firstline">Remove permission entries from an already existing asset.</p>
-<p class="toc_element">
- <code><a href="#batchUpdate">batchUpdate(id, body)</a></code></p>
-<p class="firstline">Add or update permission entries to an already existing asset.</p>
-<p class="toc_element">
- <code><a href="#list">list(id)</a></code></p>
-<p class="firstline">Return all of the permissions for the specified asset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="batchDelete">batchDelete(id, body)</code>
- <pre>Remove permission entries from an already existing asset.
-
-Args:
- id: string, The ID of the asset from which permissions will be removed. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to mapsengine.permissions.batchDelete.
- "ids": [ # An array of permission ids to be removed. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to mapsengine.permissions.batchDelete.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="batchUpdate">batchUpdate(id, body)</code>
- <pre>Add or update permission entries to an already existing asset.
-
-An asset can hold up to 20 different permission entries. Each batchInsert request is atomic.
-
-Args:
- id: string, The ID of the asset to which permissions will be added. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to mapsengine.permissions.batchUpdate.
- "permissions": [ # The permissions to be inserted or updated.
- { # A permission defines the user or group that has access to an asset, and the type of access they have.
- "type": "A String", # The account type.
- "role": "A String", # The type of access granted to this user or group.
- "discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
- "id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to mapsengine.permissions.batchUpdate.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(id)</code>
- <pre>Return all of the permissions for the specified asset.
-
-Args:
- id: string, The ID of the asset whose permissions will be listed. (required)
-
-Returns:
- An object of the form:
-
- {
- "permissions": [ # The set of permissions associated with this asset.
- { # A permission defines the user or group that has access to an asset, and the type of access they have.
- "type": "A String", # The account type.
- "role": "A String", # The type of access granted to this user or group.
- "discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
- "id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.maps.html b/docs/dyn/mapsengine_v1.maps.html
deleted file mode 100644
index 264cb07..0000000
--- a/docs/dyn/mapsengine_v1.maps.html
+++ /dev/null
@@ -1,481 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.maps.html">maps</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="mapsengine_v1.maps.permissions.html">permissions()</a></code>
-</p>
-<p class="firstline">Returns the permissions Resource.</p>
-
-<p class="toc_element">
- <code><a href="#create">create(body)</a></code></p>
-<p class="firstline">Create a map asset.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(id)</a></code></p>
-<p class="firstline">Delete a map.</p>
-<p class="toc_element">
- <code><a href="#get">get(id, version=None)</a></code></p>
-<p class="firstline">Return metadata for a particular map.</p>
-<p class="toc_element">
- <code><a href="#getPublished">getPublished(id)</a></code></p>
-<p class="firstline">Return the published metadata for a particular map.</p>
-<p class="toc_element">
- <code><a href="#list">list(modifiedBefore=None, creatorEmail=None, processingStatus=None, projectId=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</a></code></p>
-<p class="firstline">Return all maps readable by the current user.</p>
-<p class="toc_element">
- <code><a href="#listPublished">listPublished(pageToken=None, maxResults=None, projectId=None)</a></code></p>
-<p class="firstline">Return all published maps readable by the current user.</p>
-<p class="toc_element">
- <code><a href="#listPublished_next">listPublished_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="#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(id, body)</a></code></p>
-<p class="firstline">Mutate a map asset.</p>
-<p class="toc_element">
- <code><a href="#publish">publish(id, force=None)</a></code></p>
-<p class="firstline">Publish a map asset.</p>
-<p class="toc_element">
- <code><a href="#unpublish">unpublish(id)</a></code></p>
-<p class="firstline">Unpublish a map asset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(body)</code>
- <pre>Create a map asset.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Map is a collection of Layers, optionally contained within folders.
- "description": "A String", # The description of this Map, supplied by the author.
- "defaultViewport": [ # A rectangular geographic bounds. # An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this Map is in.
- "tags": [ # Tags of this Map.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishingStatus": "A String", # The publishing status of this map.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this map. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this map. This is only returned on GET requests and not LIST requests.
- "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
- "published",
- ],
- "lastModifiedTime": "A String", # The last modified time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this Map.
- "contents": [ # The contents of this Map.
- {
- },
- ],
- "name": "A String", # The name of this Map, supplied by the author.
-}
-
-
-Returns:
- An object of the form:
-
- { # A Map is a collection of Layers, optionally contained within folders.
- "description": "A String", # The description of this Map, supplied by the author.
- "defaultViewport": [ # A rectangular geographic bounds. # An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this Map is in.
- "tags": [ # Tags of this Map.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishingStatus": "A String", # The publishing status of this map.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this map. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this map. This is only returned on GET requests and not LIST requests.
- "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
- "published",
- ],
- "lastModifiedTime": "A String", # The last modified time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this Map.
- "contents": [ # The contents of this Map.
- {
- },
- ],
- "name": "A String", # The name of this Map, supplied by the author.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(id)</code>
- <pre>Delete a map.
-
-Args:
- id: string, The ID of the map. Only the map creator or project owner are permitted to delete. If the map is published the request will fail. Unpublish the map prior to deleting. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(id, version=None)</code>
- <pre>Return metadata for a particular map.
-
-Args:
- id: string, The ID of the map. (required)
- version: string, Deprecated: The version parameter indicates which version of the map should be returned. When version is set to published, the published version of the map will be returned. Please use the maps.getPublished endpoint instead.
- Allowed values
- draft - The draft version.
- published - The published version.
-
-Returns:
- An object of the form:
-
- { # A Map is a collection of Layers, optionally contained within folders.
- "description": "A String", # The description of this Map, supplied by the author.
- "defaultViewport": [ # A rectangular geographic bounds. # An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this Map is in.
- "tags": [ # Tags of this Map.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishingStatus": "A String", # The publishing status of this map.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this map. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this map. This is only returned on GET requests and not LIST requests.
- "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
- "published",
- ],
- "lastModifiedTime": "A String", # The last modified time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this Map.
- "contents": [ # The contents of this Map.
- {
- },
- ],
- "name": "A String", # The name of this Map, supplied by the author.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="getPublished">getPublished(id)</code>
- <pre>Return the published metadata for a particular map.
-
-Args:
- id: string, The ID of the map. (required)
-
-Returns:
- An object of the form:
-
- { # The published version of a map asset.
- "name": "A String", # The name of this Map, supplied by the author.
- "defaultViewport": [ # A rectangular geographic bounds. # An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "projectId": "A String", # The ID of the project that this Map is in.
- "id": "A String", # A globally unique ID, used to refer to this Map.
- "contents": [ # The contents of this Map.
- {
- },
- ],
- "description": "A String", # The description of this Map, supplied by the author.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(modifiedBefore=None, creatorEmail=None, processingStatus=None, projectId=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</code>
- <pre>Return all maps readable by the current user.
-
-Args:
- modifiedBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.
- creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
- processingStatus: string, A parameter
- Allowed values
- complete - The map has completed processing.
- failed - The map has failed processing.
- notReady - The map is not ready for processing.
- processing - The map is processing.
- projectId: string, The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
- Allowed values
- owner - The user can read, write and administer the asset.
- reader - The user can read the asset.
- writer - The user can read and write the asset.
- createdAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.
- tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
- bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
- modifiedAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.
- search: string, An unstructured search string used to filter the set of results based on asset metadata.
- createdBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to maps.List.
- "nextPageToken": "A String", # Next page token.
- "maps": [ # Resources returned.
- { # A Map is a collection of Layers, optionally contained within folders.
- "description": "A String", # The description of this Map, supplied by the author.
- "defaultViewport": [ # A rectangular geographic bounds. # An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this Map is in.
- "tags": [ # Tags of this Map.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishingStatus": "A String", # The publishing status of this map.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this map. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this map. This is only returned on GET requests and not LIST requests.
- "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
- "published",
- ],
- "lastModifiedTime": "A String", # The last modified time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this Map.
- "contents": [ # The contents of this Map.
- {
- },
- ],
- "name": "A String", # The name of this Map, supplied by the author.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="listPublished">listPublished(pageToken=None, maxResults=None, projectId=None)</code>
- <pre>Return all published maps readable by the current user.
-
-Args:
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
- projectId: string, The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to maps.List.published.
- "nextPageToken": "A String", # Next page token.
- "maps": [ # Resources returned.
- { # The published version of a map asset.
- "name": "A String", # The name of this Map, supplied by the author.
- "defaultViewport": [ # A rectangular geographic bounds. # An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "projectId": "A String", # The ID of the project that this Map is in.
- "id": "A String", # A globally unique ID, used to refer to this Map.
- "contents": [ # The contents of this Map.
- {
- },
- ],
- "description": "A String", # The description of this Map, supplied by the author.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="listPublished_next">listPublished_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="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(id, body)</code>
- <pre>Mutate a map asset.
-
-Args:
- id: string, The ID of the map. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Map is a collection of Layers, optionally contained within folders.
- "description": "A String", # The description of this Map, supplied by the author.
- "defaultViewport": [ # A rectangular geographic bounds. # An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this Map is in.
- "tags": [ # Tags of this Map.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishingStatus": "A String", # The publishing status of this map.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this map. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this map. This is only returned on GET requests and not LIST requests.
- "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
- "published",
- ],
- "lastModifiedTime": "A String", # The last modified time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this Map.
- "contents": [ # The contents of this Map.
- {
- },
- ],
- "name": "A String", # The name of this Map, supplied by the author.
-}
-
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="publish">publish(id, force=None)</code>
- <pre>Publish a map asset.
-
-Args:
- id: string, The ID of the map. (required)
- force: boolean, If set to true, the API will allow publication of the map even if it's out of date. If false, the map must have a processingStatus of complete before publishing.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to any asset's Publish method.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="unpublish">unpublish(id)</code>
- <pre>Unpublish a map asset.
-
-Args:
- id: string, The ID of the map. (required)
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to any asset's Publish method.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.maps.permissions.html b/docs/dyn/mapsengine_v1.maps.permissions.html
deleted file mode 100644
index c612ae6..0000000
--- a/docs/dyn/mapsengine_v1.maps.permissions.html
+++ /dev/null
@@ -1,162 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.maps.html">maps</a> . <a href="mapsengine_v1.maps.permissions.html">permissions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#batchDelete">batchDelete(id, body)</a></code></p>
-<p class="firstline">Remove permission entries from an already existing asset.</p>
-<p class="toc_element">
- <code><a href="#batchUpdate">batchUpdate(id, body)</a></code></p>
-<p class="firstline">Add or update permission entries to an already existing asset.</p>
-<p class="toc_element">
- <code><a href="#list">list(id)</a></code></p>
-<p class="firstline">Return all of the permissions for the specified asset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="batchDelete">batchDelete(id, body)</code>
- <pre>Remove permission entries from an already existing asset.
-
-Args:
- id: string, The ID of the asset from which permissions will be removed. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to mapsengine.permissions.batchDelete.
- "ids": [ # An array of permission ids to be removed. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to mapsengine.permissions.batchDelete.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="batchUpdate">batchUpdate(id, body)</code>
- <pre>Add or update permission entries to an already existing asset.
-
-An asset can hold up to 20 different permission entries. Each batchInsert request is atomic.
-
-Args:
- id: string, The ID of the asset to which permissions will be added. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to mapsengine.permissions.batchUpdate.
- "permissions": [ # The permissions to be inserted or updated.
- { # A permission defines the user or group that has access to an asset, and the type of access they have.
- "type": "A String", # The account type.
- "role": "A String", # The type of access granted to this user or group.
- "discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
- "id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to mapsengine.permissions.batchUpdate.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(id)</code>
- <pre>Return all of the permissions for the specified asset.
-
-Args:
- id: string, The ID of the asset whose permissions will be listed. (required)
-
-Returns:
- An object of the form:
-
- {
- "permissions": [ # The set of permissions associated with this asset.
- { # A permission defines the user or group that has access to an asset, and the type of access they have.
- "type": "A String", # The account type.
- "role": "A String", # The type of access granted to this user or group.
- "discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
- "id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.projects.html b/docs/dyn/mapsengine_v1.projects.html
deleted file mode 100644
index db31970..0000000
--- a/docs/dyn/mapsengine_v1.projects.html
+++ /dev/null
@@ -1,105 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.projects.html">projects</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="mapsengine_v1.projects.icons.html">icons()</a></code>
-</p>
-<p class="firstline">Returns the icons Resource.</p>
-
-<p class="toc_element">
- <code><a href="#list">list()</a></code></p>
-<p class="firstline">Return all projects readable by the current user.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list()</code>
- <pre>Return all projects readable by the current user.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to projects.List.
- "projects": [ # Projects returned.
- { # A Maps Engine project groups a collection of resources.
- "id": "A String", # An ID used to refer to this Maps Engine project.
- "name": "A String", # A user provided name for this Maps Engine project.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.projects.icons.html b/docs/dyn/mapsengine_v1.projects.icons.html
deleted file mode 100644
index 486cba0..0000000
--- a/docs/dyn/mapsengine_v1.projects.icons.html
+++ /dev/null
@@ -1,190 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.projects.html">projects</a> . <a href="mapsengine_v1.projects.icons.html">icons</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#create">create(projectId, body=None, media_body=None)</a></code></p>
-<p class="firstline">Create an icon.</p>
-<p class="toc_element">
- <code><a href="#get">get(projectId, id)</a></code></p>
-<p class="firstline">Return an icon or its associated metadata</p>
-<p class="toc_element">
- <code><a href="#get_media">get_media(projectId, id)</a></code></p>
-<p class="firstline">Return an icon or its associated metadata</p>
-<p class="toc_element">
- <code><a href="#list">list(projectId, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Return all icons in the current 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="create">create(projectId, body=None, media_body=None)</code>
- <pre>Create an icon.
-
-Args:
- projectId: string, The ID of the project. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # An icon is a user-uploaded image that can be used to style point geometries.
- "description": "A String", # The description of this Icon, supplied by the author.
- "name": "A String", # The name of this Icon, supplied by the author.
- "id": "A String", # An ID used to refer to this Icon.
- }
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
-
-Returns:
- An object of the form:
-
- { # An icon is a user-uploaded image that can be used to style point geometries.
- "description": "A String", # The description of this Icon, supplied by the author.
- "name": "A String", # The name of this Icon, supplied by the author.
- "id": "A String", # An ID used to refer to this Icon.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(projectId, id)</code>
- <pre>Return an icon or its associated metadata
-
-Args:
- projectId: string, The ID of the project. (required)
- id: string, The ID of the icon. (required)
-
-Returns:
- An object of the form:
-
- { # An icon is a user-uploaded image that can be used to style point geometries.
- "description": "A String", # The description of this Icon, supplied by the author.
- "name": "A String", # The name of this Icon, supplied by the author.
- "id": "A String", # An ID used to refer to this Icon.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get_media">get_media(projectId, id)</code>
- <pre>Return an icon or its associated metadata
-
-Args:
- projectId: string, The ID of the project. (required)
- id: string, The ID of the icon. (required)
-
-Returns:
- The media object as a string.
-
- </pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(projectId, pageToken=None, maxResults=None)</code>
- <pre>Return all icons in the current project
-
-Args:
- projectId: string, The ID of the project. (required)
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 50.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to icons.List.
- "nextPageToken": "A String", # Next page token.
- "icons": [ # Resources returned.
- { # An icon is a user-uploaded image that can be used to style point geometries.
- "description": "A String", # The description of this Icon, supplied by the author.
- "name": "A String", # The name of this Icon, supplied by the author.
- "id": "A String", # An ID used to refer to this Icon.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.rasterCollections.html b/docs/dyn/mapsengine_v1.rasterCollections.html
deleted file mode 100644
index bdda0af..0000000
--- a/docs/dyn/mapsengine_v1.rasterCollections.html
+++ /dev/null
@@ -1,362 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.rasterCollections.html">rasterCollections</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="mapsengine_v1.rasterCollections.parents.html">parents()</a></code>
-</p>
-<p class="firstline">Returns the parents Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.rasterCollections.permissions.html">permissions()</a></code>
-</p>
-<p class="firstline">Returns the permissions Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.rasterCollections.rasters.html">rasters()</a></code>
-</p>
-<p class="firstline">Returns the rasters Resource.</p>
-
-<p class="toc_element">
- <code><a href="#cancelProcessing">cancelProcessing(id)</a></code></p>
-<p class="firstline">Cancel processing on a raster collection asset.</p>
-<p class="toc_element">
- <code><a href="#create">create(body)</a></code></p>
-<p class="firstline">Create a raster collection asset.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(id)</a></code></p>
-<p class="firstline">Delete a raster collection.</p>
-<p class="toc_element">
- <code><a href="#get">get(id)</a></code></p>
-<p class="firstline">Return metadata for a particular raster collection.</p>
-<p class="toc_element">
- <code><a href="#list">list(modifiedBefore=None, creatorEmail=None, processingStatus=None, projectId=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</a></code></p>
-<p class="firstline">Return all raster collections readable by the current user.</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(id, body)</a></code></p>
-<p class="firstline">Mutate a raster collection asset.</p>
-<p class="toc_element">
- <code><a href="#process">process(id)</a></code></p>
-<p class="firstline">Process a raster collection asset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="cancelProcessing">cancelProcessing(id)</code>
- <pre>Cancel processing on a raster collection asset.
-
-Args:
- id: string, The ID of the raster collection. (required)
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to any asset's Process method.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="create">create(body)</code>
- <pre>Create a raster collection asset.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A raster collection groups multiple Raster resources for inclusion in a Layer.
- "attribution": "A String", # The name of the attribution to be used for this RasterCollection. Note: Attribution is returned in response to a get request but not a list request. After requesting a list of raster collections, you'll need to send a get request to retrieve the attribution for each raster collection.
- "description": "A String", # The description of this RasterCollection, supplied by the author.
- "processingStatus": "A String", # The processing status of this RasterCollection.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this RasterCollection is in.
- "tags": [ # Tags of this RasterCollection.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "rasterType": "A String", # The type of rasters contained within this RasterCollection.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this raster collection. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this RasterCollection. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this raster collection. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "id": "A String", # A globally unique ID, used to refer to this RasterCollection.
- "mosaic": True or False, # True if this RasterCollection is a mosaic.
- "name": "A String", # The name of this RasterCollection, supplied by the author.
-}
-
-
-Returns:
- An object of the form:
-
- { # A raster collection groups multiple Raster resources for inclusion in a Layer.
- "attribution": "A String", # The name of the attribution to be used for this RasterCollection. Note: Attribution is returned in response to a get request but not a list request. After requesting a list of raster collections, you'll need to send a get request to retrieve the attribution for each raster collection.
- "description": "A String", # The description of this RasterCollection, supplied by the author.
- "processingStatus": "A String", # The processing status of this RasterCollection.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this RasterCollection is in.
- "tags": [ # Tags of this RasterCollection.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "rasterType": "A String", # The type of rasters contained within this RasterCollection.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this raster collection. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this RasterCollection. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this raster collection. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "id": "A String", # A globally unique ID, used to refer to this RasterCollection.
- "mosaic": True or False, # True if this RasterCollection is a mosaic.
- "name": "A String", # The name of this RasterCollection, supplied by the author.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(id)</code>
- <pre>Delete a raster collection.
-
-Args:
- id: string, The ID of the raster collection. Only the raster collection creator or project owner are permitted to delete. If the rastor collection is included in a layer, the request will fail. Remove the raster collection from all layers prior to deleting. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(id)</code>
- <pre>Return metadata for a particular raster collection.
-
-Args:
- id: string, The ID of the raster collection. (required)
-
-Returns:
- An object of the form:
-
- { # A raster collection groups multiple Raster resources for inclusion in a Layer.
- "attribution": "A String", # The name of the attribution to be used for this RasterCollection. Note: Attribution is returned in response to a get request but not a list request. After requesting a list of raster collections, you'll need to send a get request to retrieve the attribution for each raster collection.
- "description": "A String", # The description of this RasterCollection, supplied by the author.
- "processingStatus": "A String", # The processing status of this RasterCollection.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this RasterCollection is in.
- "tags": [ # Tags of this RasterCollection.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "rasterType": "A String", # The type of rasters contained within this RasterCollection.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this raster collection. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this RasterCollection. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this raster collection. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "id": "A String", # A globally unique ID, used to refer to this RasterCollection.
- "mosaic": True or False, # True if this RasterCollection is a mosaic.
- "name": "A String", # The name of this RasterCollection, supplied by the author.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(modifiedBefore=None, creatorEmail=None, processingStatus=None, projectId=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</code>
- <pre>Return all raster collections readable by the current user.
-
-Args:
- modifiedBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.
- creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
- processingStatus: string, A parameter
- Allowed values
- complete - The raster collection has completed processing.
- failed - The raster collection has failed processing.
- notReady - The raster collection is not ready for processing.
- processing - The raster collection is processing.
- ready - The raster collection is ready for processing.
- projectId: string, The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
- Allowed values
- owner - The user can read, write and administer the asset.
- reader - The user can read the asset.
- writer - The user can read and write the asset.
- createdAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.
- tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
- bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
- modifiedAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.
- search: string, An unstructured search string used to filter the set of results based on asset metadata.
- createdBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to raster_collections.List. Note: The list response does not include all the fields available in a raster collection. Refer to the RasterCollection resource description for details of the fields that are not included. You'll need to send a get request to retrieve the additional fields for each raster collection.
- "nextPageToken": "A String", # Next page token.
- "rasterCollections": [ # Resources returned.
- { # A raster collection groups multiple Raster resources for inclusion in a Layer.
- "attribution": "A String", # The name of the attribution to be used for this RasterCollection. Note: Attribution is returned in response to a get request but not a list request. After requesting a list of raster collections, you'll need to send a get request to retrieve the attribution for each raster collection.
- "description": "A String", # The description of this RasterCollection, supplied by the author.
- "processingStatus": "A String", # The processing status of this RasterCollection.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this RasterCollection is in.
- "tags": [ # Tags of this RasterCollection.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "rasterType": "A String", # The type of rasters contained within this RasterCollection.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this raster collection. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this RasterCollection. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this raster collection. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "id": "A String", # A globally unique ID, used to refer to this RasterCollection.
- "mosaic": True or False, # True if this RasterCollection is a mosaic.
- "name": "A String", # The name of this RasterCollection, supplied by the author.
- },
- ],
- }</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(id, body)</code>
- <pre>Mutate a raster collection asset.
-
-Args:
- id: string, The ID of the raster collection. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A raster collection groups multiple Raster resources for inclusion in a Layer.
- "attribution": "A String", # The name of the attribution to be used for this RasterCollection. Note: Attribution is returned in response to a get request but not a list request. After requesting a list of raster collections, you'll need to send a get request to retrieve the attribution for each raster collection.
- "description": "A String", # The description of this RasterCollection, supplied by the author.
- "processingStatus": "A String", # The processing status of this RasterCollection.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this RasterCollection is in.
- "tags": [ # Tags of this RasterCollection.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "rasterType": "A String", # The type of rasters contained within this RasterCollection.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this raster collection. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this RasterCollection. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this raster collection. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "id": "A String", # A globally unique ID, used to refer to this RasterCollection.
- "mosaic": True or False, # True if this RasterCollection is a mosaic.
- "name": "A String", # The name of this RasterCollection, supplied by the author.
-}
-
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="process">process(id)</code>
- <pre>Process a raster collection asset.
-
-Args:
- id: string, The ID of the raster collection. (required)
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to any asset's Process method.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.rasterCollections.parents.html b/docs/dyn/mapsengine_v1.rasterCollections.parents.html
deleted file mode 100644
index be7ce67..0000000
--- a/docs/dyn/mapsengine_v1.rasterCollections.parents.html
+++ /dev/null
@@ -1,120 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.rasterCollections.html">rasterCollections</a> . <a href="mapsengine_v1.rasterCollections.parents.html">parents</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(id, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Return all parent ids of the specified raster collection.</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(id, pageToken=None, maxResults=None)</code>
- <pre>Return all parent ids of the specified raster collection.
-
-Args:
- id: string, The ID of the raster collection whose parents will be listed. (required)
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 50.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to parents.List.
- "nextPageToken": "A String", # Next page token.
- "parents": [ # The parent assets.
- { # A list of the parents of an asset.
- "id": "A String", # The ID of this parent.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.rasterCollections.permissions.html b/docs/dyn/mapsengine_v1.rasterCollections.permissions.html
deleted file mode 100644
index b3a3c92..0000000
--- a/docs/dyn/mapsengine_v1.rasterCollections.permissions.html
+++ /dev/null
@@ -1,162 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.rasterCollections.html">rasterCollections</a> . <a href="mapsengine_v1.rasterCollections.permissions.html">permissions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#batchDelete">batchDelete(id, body)</a></code></p>
-<p class="firstline">Remove permission entries from an already existing asset.</p>
-<p class="toc_element">
- <code><a href="#batchUpdate">batchUpdate(id, body)</a></code></p>
-<p class="firstline">Add or update permission entries to an already existing asset.</p>
-<p class="toc_element">
- <code><a href="#list">list(id)</a></code></p>
-<p class="firstline">Return all of the permissions for the specified asset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="batchDelete">batchDelete(id, body)</code>
- <pre>Remove permission entries from an already existing asset.
-
-Args:
- id: string, The ID of the asset from which permissions will be removed. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to mapsengine.permissions.batchDelete.
- "ids": [ # An array of permission ids to be removed. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to mapsengine.permissions.batchDelete.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="batchUpdate">batchUpdate(id, body)</code>
- <pre>Add or update permission entries to an already existing asset.
-
-An asset can hold up to 20 different permission entries. Each batchInsert request is atomic.
-
-Args:
- id: string, The ID of the asset to which permissions will be added. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to mapsengine.permissions.batchUpdate.
- "permissions": [ # The permissions to be inserted or updated.
- { # A permission defines the user or group that has access to an asset, and the type of access they have.
- "type": "A String", # The account type.
- "role": "A String", # The type of access granted to this user or group.
- "discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
- "id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to mapsengine.permissions.batchUpdate.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(id)</code>
- <pre>Return all of the permissions for the specified asset.
-
-Args:
- id: string, The ID of the asset whose permissions will be listed. (required)
-
-Returns:
- An object of the form:
-
- {
- "permissions": [ # The set of permissions associated with this asset.
- { # A permission defines the user or group that has access to an asset, and the type of access they have.
- "type": "A String", # The account type.
- "role": "A String", # The type of access granted to this user or group.
- "discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
- "id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.rasterCollections.rasters.html b/docs/dyn/mapsengine_v1.rasterCollections.rasters.html
deleted file mode 100644
index 46307d8..0000000
--- a/docs/dyn/mapsengine_v1.rasterCollections.rasters.html
+++ /dev/null
@@ -1,201 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.rasterCollections.html">rasterCollections</a> . <a href="mapsengine_v1.rasterCollections.rasters.html">rasters</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#batchDelete">batchDelete(id, body)</a></code></p>
-<p class="firstline">Remove rasters from an existing raster collection.</p>
-<p class="toc_element">
- <code><a href="#batchInsert">batchInsert(id, body)</a></code></p>
-<p class="firstline">Add rasters to an existing raster collection. Rasters must be successfully processed in order to be added to a raster collection.</p>
-<p class="toc_element">
- <code><a href="#list">list(id, modifiedBefore=None, creatorEmail=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</a></code></p>
-<p class="firstline">Return all rasters within a raster collection.</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="batchDelete">batchDelete(id, body)</code>
- <pre>Remove rasters from an existing raster collection.
-
-Up to 50 rasters can be included in a single batchDelete request. Each batchDelete request is atomic.
-
-Args:
- id: string, The ID of the raster collection to which these rasters belong. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to rasterCollections.Rasters.BatchDelete.
- "ids": [ # An array of Raster asset IDs to be removed from this RasterCollection.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to rasterCollections.rasters.batchDelete.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="batchInsert">batchInsert(id, body)</code>
- <pre>Add rasters to an existing raster collection. Rasters must be successfully processed in order to be added to a raster collection.
-
-Up to 50 rasters can be included in a single batchInsert request. Each batchInsert request is atomic.
-
-Args:
- id: string, The ID of the raster collection to which these rasters belong. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to rasterCollections.Rasters.BatchInsert.
- "ids": [ # An array of Raster asset IDs to be added to this RasterCollection.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to rasterCollections.rasters.batchInsert.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(id, modifiedBefore=None, creatorEmail=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</code>
- <pre>Return all rasters within a raster collection.
-
-Args:
- id: string, The ID of the raster collection to which these rasters belong. (required)
- modifiedBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.
- creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
- Allowed values
- owner - The user can read, write and administer the asset.
- reader - The user can read the asset.
- writer - The user can read and write the asset.
- createdAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.
- tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
- bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
- modifiedAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.
- search: string, An unstructured search string used to filter the set of results based on asset metadata.
- createdBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to rasterCollections.rasters.List.
- "nextPageToken": "A String", # Next page token.
- "rasters": [ # Resources returned.
- { # A raster resource.
- "name": "A String", # The name of this Raster, supplied by the author.
- "tags": [ # Tags of this Raster.
- "A String",
- ],
- "rasterType": "image", # The type of this Raster. Always "image" today.
- "projectId": "A String", # The ID of the project that this Raster is in.
- "creationTime": "A String", # The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
- 3.14,
- ],
- "lastModifiedTime": "A String", # The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "id": "A String", # A globally unique ID, used to refer to this Raster.
- "description": "A String", # The description of this Raster, supplied by the author.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.rasters.files.html b/docs/dyn/mapsengine_v1.rasters.files.html
deleted file mode 100644
index 626862e..0000000
--- a/docs/dyn/mapsengine_v1.rasters.files.html
+++ /dev/null
@@ -1,92 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.rasters.html">rasters</a> . <a href="mapsengine_v1.rasters.files.html">files</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#insert">insert(id, filename, media_body=None)</a></code></p>
-<p class="firstline">Upload a file to a raster asset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="insert">insert(id, filename, media_body=None)</code>
- <pre>Upload a file to a raster asset.
-
-Args:
- id: string, The ID of the raster asset. (required)
- filename: string, The file name of this uploaded file. (required)
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
-</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.rasters.html b/docs/dyn/mapsengine_v1.rasters.html
deleted file mode 100644
index 8c7a2f6..0000000
--- a/docs/dyn/mapsengine_v1.rasters.html
+++ /dev/null
@@ -1,405 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.rasters.html">rasters</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="mapsengine_v1.rasters.files.html">files()</a></code>
-</p>
-<p class="firstline">Returns the files Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.rasters.parents.html">parents()</a></code>
-</p>
-<p class="firstline">Returns the parents Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.rasters.permissions.html">permissions()</a></code>
-</p>
-<p class="firstline">Returns the permissions Resource.</p>
-
-<p class="toc_element">
- <code><a href="#delete">delete(id)</a></code></p>
-<p class="firstline">Delete a raster.</p>
-<p class="toc_element">
- <code><a href="#get">get(id)</a></code></p>
-<p class="firstline">Return metadata for a single raster.</p>
-<p class="toc_element">
- <code><a href="#list">list(projectId, modifiedBefore=None, creatorEmail=None, processingStatus=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</a></code></p>
-<p class="firstline">Return all rasters readable by the current user.</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(id, body)</a></code></p>
-<p class="firstline">Mutate a raster asset.</p>
-<p class="toc_element">
- <code><a href="#process">process(id)</a></code></p>
-<p class="firstline">Process a raster asset.</p>
-<p class="toc_element">
- <code><a href="#upload">upload(body)</a></code></p>
-<p class="firstline">Create a skeleton raster asset for upload.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(id)</code>
- <pre>Delete a raster.
-
-Args:
- id: string, The ID of the raster. Only the raster creator or project owner are permitted to delete. If the raster is included in a layer or mosaic, the request will fail. Remove it from all parents prior to deleting. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(id)</code>
- <pre>Return metadata for a single raster.
-
-Args:
- id: string, The ID of the raster. (required)
-
-Returns:
- An object of the form:
-
- { # A geo-referenced raster.
- "files": [ # The files associated with this Raster.
- { # A single File, which is a component of an Asset.
- "size": "A String", # The size of the file in bytes.
- "uploadStatus": "A String", # The upload status of the file.
- "filename": "A String", # The name of the file.
- },
- ],
- "attribution": "A String", # The name of the attribution to be used for this Raster.
- "description": "A String", # The description of this Raster, supplied by the author.
- "processingStatus": "A String", # The processing status of this Raster.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this Raster is in.
- "tags": [ # Tags of this Raster.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "name": "A String", # The name of this Raster, supplied by the author.
- "maskType": "autoMask", # The mask processing type of this Raster.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
- "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
- "start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
- "end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
- "precision": "A String", # The precision of acquisition time.
- },
- "lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "id": "A String", # A globally unique ID, used to refer to this Raster.
- "rasterType": "A String", # The type of this Raster. Always "image" today.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
- 3.14,
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(projectId, modifiedBefore=None, creatorEmail=None, processingStatus=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</code>
- <pre>Return all rasters readable by the current user.
-
-Args:
- projectId: string, The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com. (required)
- modifiedBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.
- creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
- processingStatus: string, A parameter
- Allowed values
- complete - The raster has completed processing.
- failed - The raster has failed processing.
- notReady - The raster is not ready for processing.
- processing - The raster is processing.
- ready - The raster is ready for processing.
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
- Allowed values
- owner - The user can read, write and administer the asset.
- reader - The user can read the asset.
- writer - The user can read and write the asset.
- createdAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.
- tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
- bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
- modifiedAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.
- search: string, An unstructured search string used to filter the set of results based on asset metadata.
- createdBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to rasters.List.
- "nextPageToken": "A String", # Next page token.
- "rasters": [ # Resources returned.
- { # A geo-referenced raster.
- "files": [ # The files associated with this Raster.
- { # A single File, which is a component of an Asset.
- "size": "A String", # The size of the file in bytes.
- "uploadStatus": "A String", # The upload status of the file.
- "filename": "A String", # The name of the file.
- },
- ],
- "attribution": "A String", # The name of the attribution to be used for this Raster.
- "description": "A String", # The description of this Raster, supplied by the author.
- "processingStatus": "A String", # The processing status of this Raster.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this Raster is in.
- "tags": [ # Tags of this Raster.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "name": "A String", # The name of this Raster, supplied by the author.
- "maskType": "autoMask", # The mask processing type of this Raster.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
- "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
- "start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
- "end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
- "precision": "A String", # The precision of acquisition time.
- },
- "lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "id": "A String", # A globally unique ID, used to refer to this Raster.
- "rasterType": "A String", # The type of this Raster. Always "image" today.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
- 3.14,
- ],
- },
- ],
- }</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(id, body)</code>
- <pre>Mutate a raster asset.
-
-Args:
- id: string, The ID of the raster. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A geo-referenced raster.
- "files": [ # The files associated with this Raster.
- { # A single File, which is a component of an Asset.
- "size": "A String", # The size of the file in bytes.
- "uploadStatus": "A String", # The upload status of the file.
- "filename": "A String", # The name of the file.
- },
- ],
- "attribution": "A String", # The name of the attribution to be used for this Raster.
- "description": "A String", # The description of this Raster, supplied by the author.
- "processingStatus": "A String", # The processing status of this Raster.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this Raster is in.
- "tags": [ # Tags of this Raster.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "name": "A String", # The name of this Raster, supplied by the author.
- "maskType": "autoMask", # The mask processing type of this Raster.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
- "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
- "start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
- "end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
- "precision": "A String", # The precision of acquisition time.
- },
- "lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "id": "A String", # A globally unique ID, used to refer to this Raster.
- "rasterType": "A String", # The type of this Raster. Always "image" today.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
- 3.14,
- ],
-}
-
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="process">process(id)</code>
- <pre>Process a raster asset.
-
-Args:
- id: string, The ID of the raster. (required)
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to any asset's Process method.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="upload">upload(body)</code>
- <pre>Create a skeleton raster asset for upload.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A geo-referenced raster.
- "files": [ # The files associated with this Raster.
- { # A single File, which is a component of an Asset.
- "size": "A String", # The size of the file in bytes.
- "uploadStatus": "A String", # The upload status of the file.
- "filename": "A String", # The name of the file.
- },
- ],
- "attribution": "A String", # The name of the attribution to be used for this Raster.
- "description": "A String", # The description of this Raster, supplied by the author.
- "processingStatus": "A String", # The processing status of this Raster.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this Raster is in.
- "tags": [ # Tags of this Raster.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "name": "A String", # The name of this Raster, supplied by the author.
- "maskType": "autoMask", # The mask processing type of this Raster.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
- "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
- "start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
- "end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
- "precision": "A String", # The precision of acquisition time.
- },
- "lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "id": "A String", # A globally unique ID, used to refer to this Raster.
- "rasterType": "A String", # The type of this Raster. Always "image" today.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
- 3.14,
- ],
-}
-
-
-Returns:
- An object of the form:
-
- { # A geo-referenced raster.
- "files": [ # The files associated with this Raster.
- { # A single File, which is a component of an Asset.
- "size": "A String", # The size of the file in bytes.
- "uploadStatus": "A String", # The upload status of the file.
- "filename": "A String", # The name of the file.
- },
- ],
- "attribution": "A String", # The name of the attribution to be used for this Raster.
- "description": "A String", # The description of this Raster, supplied by the author.
- "processingStatus": "A String", # The processing status of this Raster.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project that this Raster is in.
- "tags": [ # Tags of this Raster.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "name": "A String", # The name of this Raster, supplied by the author.
- "maskType": "autoMask", # The mask processing type of this Raster.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
- "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
- "start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
- "end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
- "precision": "A String", # The precision of acquisition time.
- },
- "lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "id": "A String", # A globally unique ID, used to refer to this Raster.
- "rasterType": "A String", # The type of this Raster. Always "image" today.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
- 3.14,
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.rasters.parents.html b/docs/dyn/mapsengine_v1.rasters.parents.html
deleted file mode 100644
index dea225c..0000000
--- a/docs/dyn/mapsengine_v1.rasters.parents.html
+++ /dev/null
@@ -1,120 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.rasters.html">rasters</a> . <a href="mapsengine_v1.rasters.parents.html">parents</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(id, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Return all parent ids of the specified rasters.</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(id, pageToken=None, maxResults=None)</code>
- <pre>Return all parent ids of the specified rasters.
-
-Args:
- id: string, The ID of the rasters whose parents will be listed. (required)
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 50.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to parents.List.
- "nextPageToken": "A String", # Next page token.
- "parents": [ # The parent assets.
- { # A list of the parents of an asset.
- "id": "A String", # The ID of this parent.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.rasters.permissions.html b/docs/dyn/mapsengine_v1.rasters.permissions.html
deleted file mode 100644
index 8049212..0000000
--- a/docs/dyn/mapsengine_v1.rasters.permissions.html
+++ /dev/null
@@ -1,162 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.rasters.html">rasters</a> . <a href="mapsengine_v1.rasters.permissions.html">permissions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#batchDelete">batchDelete(id, body)</a></code></p>
-<p class="firstline">Remove permission entries from an already existing asset.</p>
-<p class="toc_element">
- <code><a href="#batchUpdate">batchUpdate(id, body)</a></code></p>
-<p class="firstline">Add or update permission entries to an already existing asset.</p>
-<p class="toc_element">
- <code><a href="#list">list(id)</a></code></p>
-<p class="firstline">Return all of the permissions for the specified asset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="batchDelete">batchDelete(id, body)</code>
- <pre>Remove permission entries from an already existing asset.
-
-Args:
- id: string, The ID of the asset from which permissions will be removed. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to mapsengine.permissions.batchDelete.
- "ids": [ # An array of permission ids to be removed. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to mapsengine.permissions.batchDelete.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="batchUpdate">batchUpdate(id, body)</code>
- <pre>Add or update permission entries to an already existing asset.
-
-An asset can hold up to 20 different permission entries. Each batchInsert request is atomic.
-
-Args:
- id: string, The ID of the asset to which permissions will be added. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to mapsengine.permissions.batchUpdate.
- "permissions": [ # The permissions to be inserted or updated.
- { # A permission defines the user or group that has access to an asset, and the type of access they have.
- "type": "A String", # The account type.
- "role": "A String", # The type of access granted to this user or group.
- "discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
- "id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to mapsengine.permissions.batchUpdate.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(id)</code>
- <pre>Return all of the permissions for the specified asset.
-
-Args:
- id: string, The ID of the asset whose permissions will be listed. (required)
-
-Returns:
- An object of the form:
-
- {
- "permissions": [ # The set of permissions associated with this asset.
- { # A permission defines the user or group that has access to an asset, and the type of access they have.
- "type": "A String", # The account type.
- "role": "A String", # The type of access granted to this user or group.
- "discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
- "id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.tables.features.html b/docs/dyn/mapsengine_v1.tables.features.html
deleted file mode 100644
index 32eea5a..0000000
--- a/docs/dyn/mapsengine_v1.tables.features.html
+++ /dev/null
@@ -1,280 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.tables.html">tables</a> . <a href="mapsengine_v1.tables.features.html">features</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#batchDelete">batchDelete(id, body)</a></code></p>
-<p class="firstline">Delete all features matching the given IDs.</p>
-<p class="toc_element">
- <code><a href="#batchInsert">batchInsert(id, body)</a></code></p>
-<p class="firstline">Append features to an existing table.</p>
-<p class="toc_element">
- <code><a href="#batchPatch">batchPatch(id, body)</a></code></p>
-<p class="firstline">Update the supplied features.</p>
-<p class="toc_element">
- <code><a href="#get">get(tableId, id, version=None, select=None)</a></code></p>
-<p class="firstline">Return a single feature, given its ID.</p>
-<p class="toc_element">
- <code><a href="#list">list(id, orderBy=None, intersects=None, pageToken=None, maxResults=None, version=None, limit=None, include=None, where=None, select=None)</a></code></p>
-<p class="firstline">Return all features readable by the current user.</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="batchDelete">batchDelete(id, body)</code>
- <pre>Delete all features matching the given IDs.
-
-Args:
- id: string, The ID of the table that contains the features to be deleted. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to features.BatchDelete.
- "gx_ids": [
- "A String",
- ],
- "primaryKeys": [
- "A String",
- ],
- }
-
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="batchInsert">batchInsert(id, body)</code>
- <pre>Append features to an existing table.
-
-A single batchInsert request can create:
-
-- Up to 50 features.
-- A combined total of 10 000 vertices.
-Feature limits are documented in the Supported data formats and limits article of the Google Maps Engine help center. Note that free and paid accounts have different limits.
-
-For more information about inserting features, read Creating features in the Google Maps Engine developer's guide.
-
-Args:
- id: string, The ID of the table to append the features to. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to features.Insert.
- "normalizeGeometries": true, # If true, the server will normalize feature geometries. It is assumed that the South Pole is exterior to any polygons given. See here for a list of normalizations. If false, all feature geometries must be given already normalized. The points in all LinearRings must be listed in counter-clockwise order, and LinearRings may not intersect.
- "features": [
- { # A feature within a table.
- "geometry": { # The geometry member of this Feature.
- },
- "type": "Feature", # Identifies this object as a feature.
- "properties": { # The properties associated with a feature. # Key/value pairs of this Feature.
- "a_key": "", # An arbitrary key-value pair. The key must be the name of a column in the table's schema, and the type of the value must correspond to the type specified in the schema.
- },
- },
- ],
- }
-
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="batchPatch">batchPatch(id, body)</code>
- <pre>Update the supplied features.
-
-A single batchPatch request can update:
-
-- Up to 50 features.
-- A combined total of 10 000 vertices.
-Feature limits are documented in the Supported data formats and limits article of the Google Maps Engine help center. Note that free and paid accounts have different limits.
-
-Feature updates use HTTP PATCH semantics:
-
-- A supplied value replaces an existing value (if any) in that field.
-- Omitted fields remain unchanged.
-- Complex values in geometries and properties must be replaced as atomic units. For example, providing just the coordinates of a geometry is not allowed; the complete geometry, including type, must be supplied.
-- Setting a property's value to null deletes that property.
-For more information about updating features, read Updating features in the Google Maps Engine developer's guide.
-
-Args:
- id: string, The ID of the table containing the features to be patched. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to features.BatchPatch.
- "normalizeGeometries": true, # If true, the server will normalize feature geometries. It is assumed that the South Pole is exterior to any polygons given. See here for a list of normalizations. If false, all feature geometries must be given already normalized. The points in all LinearRings must be listed in counter-clockwise order, and LinearRings may not intersect.
- "features": [
- { # A feature within a table.
- "geometry": { # The geometry member of this Feature.
- },
- "type": "Feature", # Identifies this object as a feature.
- "properties": { # The properties associated with a feature. # Key/value pairs of this Feature.
- "a_key": "", # An arbitrary key-value pair. The key must be the name of a column in the table's schema, and the type of the value must correspond to the type specified in the schema.
- },
- },
- ],
- }
-
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(tableId, id, version=None, select=None)</code>
- <pre>Return a single feature, given its ID.
-
-Args:
- tableId: string, The ID of the table. (required)
- id: string, The ID of the feature to get. (required)
- version: string, The table version to access. See Accessing Public Data for information.
- Allowed values
- draft - The draft version.
- published - The published version.
- select: string, A SQL-like projection clause used to specify returned properties. If this parameter is not included, all properties are returned.
-
-Returns:
- An object of the form:
-
- { # A feature within a table.
- "geometry": { # The geometry member of this Feature.
- },
- "type": "Feature", # Identifies this object as a feature.
- "properties": { # The properties associated with a feature. # Key/value pairs of this Feature.
- "a_key": "", # An arbitrary key-value pair. The key must be the name of a column in the table's schema, and the type of the value must correspond to the type specified in the schema.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(id, orderBy=None, intersects=None, pageToken=None, maxResults=None, version=None, limit=None, include=None, where=None, select=None)</code>
- <pre>Return all features readable by the current user.
-
-Args:
- id: string, The ID of the table to which these features belong. (required)
- orderBy: string, An SQL-like order by clause used to sort results. If this parameter is not included, the order of features is undefined.
- intersects: string, A geometry literal that specifies the spatial restriction of the query.
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- maxResults: integer, The maximum number of items to include in the response, used for paging. The maximum supported value is 1000.
- version: string, The table version to access. See Accessing Public Data for information.
- Allowed values
- draft - The draft version.
- published - The published version.
- limit: integer, The total number of features to return from the query, irrespective of the number of pages.
- include: string, A comma separated list of optional data to include. Optional data available: schema.
- where: string, An SQL-like predicate used to filter results.
- select: string, A SQL-like projection clause used to specify returned properties. If this parameter is not included, all properties are returned.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to features.List.
- "nextPageToken": "A String", # Next page token.
- "allowedQueriesPerSecond": 3.14, # An indicator of the maximum rate at which queries may be made, if all queries were as expensive as this query.
- "type": "FeatureCollection",
- "features": [ # Resources returned.
- { # A feature within a table.
- "geometry": { # The geometry member of this Feature.
- },
- "type": "Feature", # Identifies this object as a feature.
- "properties": { # The properties associated with a feature. # Key/value pairs of this Feature.
- "a_key": "", # An arbitrary key-value pair. The key must be the name of a column in the table's schema, and the type of the value must correspond to the type specified in the schema.
- },
- },
- ],
- "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The feature schema.
- "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
- "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
- "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
- {
- "type": "A String", # The type of data stored in this column.
- "name": "A String", # The column name.
- },
- ],
- },
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.tables.files.html b/docs/dyn/mapsengine_v1.tables.files.html
deleted file mode 100644
index aaebf5c..0000000
--- a/docs/dyn/mapsengine_v1.tables.files.html
+++ /dev/null
@@ -1,93 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.tables.html">tables</a> . <a href="mapsengine_v1.tables.files.html">files</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#insert">insert(id, filename, media_body=None)</a></code></p>
-<p class="firstline">Upload a file to a placeholder table asset. See Table Upload in the Developer's Guide for more information.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="insert">insert(id, filename, media_body=None)</code>
- <pre>Upload a file to a placeholder table asset. See Table Upload in the Developer's Guide for more information.
-Supported file types are listed in the Supported data formats and limits article of the Google Maps Engine help center.
-
-Args:
- id: string, The ID of the table asset. (required)
- filename: string, The file name of this uploaded file. (required)
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
-</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.tables.html b/docs/dyn/mapsengine_v1.tables.html
deleted file mode 100644
index 7a2f7c2..0000000
--- a/docs/dyn/mapsengine_v1.tables.html
+++ /dev/null
@@ -1,532 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.tables.html">tables</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="mapsengine_v1.tables.features.html">features()</a></code>
-</p>
-<p class="firstline">Returns the features Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.tables.files.html">files()</a></code>
-</p>
-<p class="firstline">Returns the files Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.tables.parents.html">parents()</a></code>
-</p>
-<p class="firstline">Returns the parents Resource.</p>
-
-<p class="toc_element">
- <code><a href="mapsengine_v1.tables.permissions.html">permissions()</a></code>
-</p>
-<p class="firstline">Returns the permissions Resource.</p>
-
-<p class="toc_element">
- <code><a href="#create">create(body)</a></code></p>
-<p class="firstline">Create a table asset.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(id)</a></code></p>
-<p class="firstline">Delete a table.</p>
-<p class="toc_element">
- <code><a href="#get">get(id, version=None)</a></code></p>
-<p class="firstline">Return metadata for a particular table, including the schema.</p>
-<p class="toc_element">
- <code><a href="#list">list(modifiedBefore=None, creatorEmail=None, processingStatus=None, projectId=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</a></code></p>
-<p class="firstline">Return all tables readable by the current user.</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(id, body)</a></code></p>
-<p class="firstline">Mutate a table asset.</p>
-<p class="toc_element">
- <code><a href="#process">process(id)</a></code></p>
-<p class="firstline">Process a table asset.</p>
-<p class="toc_element">
- <code><a href="#upload">upload(body)</a></code></p>
-<p class="firstline">Create a placeholder table asset to which table files can be uploaded.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(body)</code>
- <pre>Create a table asset.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A collection of geographic features, and associated metadata.
- "files": [ # The files associated with this table.
- { # A single File, which is a component of an Asset.
- "size": "A String", # The size of the file in bytes.
- "uploadStatus": "A String", # The upload status of the file.
- "filename": "A String", # The name of the file.
- },
- ],
- "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
- "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
- "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
- "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
- {
- "type": "A String", # The type of data stored in this column.
- "name": "A String", # The column name.
- },
- ],
- },
- "description": "A String", # The description of this table, supplied by the author.
- "processingStatus": "A String", # The processing status of this table.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project to which the table belongs.
- "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this table.
- "name": "A String", # The name of this table, supplied by the author.
-}
-
-
-Returns:
- An object of the form:
-
- { # A collection of geographic features, and associated metadata.
- "files": [ # The files associated with this table.
- { # A single File, which is a component of an Asset.
- "size": "A String", # The size of the file in bytes.
- "uploadStatus": "A String", # The upload status of the file.
- "filename": "A String", # The name of the file.
- },
- ],
- "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
- "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
- "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
- "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
- {
- "type": "A String", # The type of data stored in this column.
- "name": "A String", # The column name.
- },
- ],
- },
- "description": "A String", # The description of this table, supplied by the author.
- "processingStatus": "A String", # The processing status of this table.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project to which the table belongs.
- "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this table.
- "name": "A String", # The name of this table, supplied by the author.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(id)</code>
- <pre>Delete a table.
-
-Args:
- id: string, The ID of the table. Only the table creator or project owner are permitted to delete. If the table is included in a layer, the request will fail. Remove it from all layers prior to deleting. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(id, version=None)</code>
- <pre>Return metadata for a particular table, including the schema.
-
-Args:
- id: string, The ID of the table. (required)
- version: string, A parameter
- Allowed values
- draft - The draft version.
- published - The published version.
-
-Returns:
- An object of the form:
-
- { # A collection of geographic features, and associated metadata.
- "files": [ # The files associated with this table.
- { # A single File, which is a component of an Asset.
- "size": "A String", # The size of the file in bytes.
- "uploadStatus": "A String", # The upload status of the file.
- "filename": "A String", # The name of the file.
- },
- ],
- "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
- "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
- "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
- "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
- {
- "type": "A String", # The type of data stored in this column.
- "name": "A String", # The column name.
- },
- ],
- },
- "description": "A String", # The description of this table, supplied by the author.
- "processingStatus": "A String", # The processing status of this table.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project to which the table belongs.
- "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this table.
- "name": "A String", # The name of this table, supplied by the author.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(modifiedBefore=None, creatorEmail=None, processingStatus=None, projectId=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</code>
- <pre>Return all tables readable by the current user.
-
-Args:
- modifiedBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.
- creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
- processingStatus: string, A parameter
- Allowed values
- complete - The table has completed processing.
- failed - The table has failed processing.
- notReady - The table is not ready for processing.
- processing - The table is processing.
- ready - The table is ready for processing.
- projectId: string, The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
- Allowed values
- owner - The user can read, write and administer the asset.
- reader - The user can read the asset.
- writer - The user can read and write the asset.
- createdAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.
- tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
- bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
- modifiedAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.
- search: string, An unstructured search string used to filter the set of results based on asset metadata.
- createdBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to tables.List. Note: The list response does not include all the fields available in a table. Refer to the table resource description for details of the fields that are not included. You'll need to send a get request to retrieve the additional fields for each table.
- "nextPageToken": "A String", # Next page token.
- "tables": [ # Resources returned.
- { # A collection of geographic features, and associated metadata.
- "files": [ # The files associated with this table.
- { # A single File, which is a component of an Asset.
- "size": "A String", # The size of the file in bytes.
- "uploadStatus": "A String", # The upload status of the file.
- "filename": "A String", # The name of the file.
- },
- ],
- "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
- "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
- "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
- "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
- {
- "type": "A String", # The type of data stored in this column.
- "name": "A String", # The column name.
- },
- ],
- },
- "description": "A String", # The description of this table, supplied by the author.
- "processingStatus": "A String", # The processing status of this table.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project to which the table belongs.
- "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this table.
- "name": "A String", # The name of this table, supplied by the author.
- },
- ],
- }</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(id, body)</code>
- <pre>Mutate a table asset.
-
-Args:
- id: string, The ID of the table. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A collection of geographic features, and associated metadata.
- "files": [ # The files associated with this table.
- { # A single File, which is a component of an Asset.
- "size": "A String", # The size of the file in bytes.
- "uploadStatus": "A String", # The upload status of the file.
- "filename": "A String", # The name of the file.
- },
- ],
- "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
- "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
- "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
- "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
- {
- "type": "A String", # The type of data stored in this column.
- "name": "A String", # The column name.
- },
- ],
- },
- "description": "A String", # The description of this table, supplied by the author.
- "processingStatus": "A String", # The processing status of this table.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project to which the table belongs.
- "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this table.
- "name": "A String", # The name of this table, supplied by the author.
-}
-
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="process">process(id)</code>
- <pre>Process a table asset.
-
-Args:
- id: string, The ID of the table. (required)
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to any asset's Process method.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="upload">upload(body)</code>
- <pre>Create a placeholder table asset to which table files can be uploaded.
-Once the placeholder has been created, files are uploaded to the https://www.googleapis.com/upload/mapsengine/v1/tables/table_id/files endpoint.
-See Table Upload in the Developer's Guide or Table.files: insert in the reference documentation for more information.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A collection of geographic features, and associated metadata.
- "files": [ # The files associated with this table.
- { # A single File, which is a component of an Asset.
- "size": "A String", # The size of the file in bytes.
- "uploadStatus": "A String", # The upload status of the file.
- "filename": "A String", # The name of the file.
- },
- ],
- "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
- "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
- "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
- "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
- {
- "type": "A String", # The type of data stored in this column.
- "name": "A String", # The column name.
- },
- ],
- },
- "description": "A String", # The description of this table, supplied by the author.
- "processingStatus": "A String", # The processing status of this table.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project to which the table belongs.
- "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this table.
- "name": "A String", # The name of this table, supplied by the author.
-}
-
-
-Returns:
- An object of the form:
-
- { # A collection of geographic features, and associated metadata.
- "files": [ # The files associated with this table.
- { # A single File, which is a component of an Asset.
- "size": "A String", # The size of the file in bytes.
- "uploadStatus": "A String", # The upload status of the file.
- "filename": "A String", # The name of the file.
- },
- ],
- "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
- "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
- "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
- "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
- {
- "type": "A String", # The type of data stored in this column.
- "name": "A String", # The column name.
- },
- ],
- },
- "description": "A String", # The description of this table, supplied by the author.
- "processingStatus": "A String", # The processing status of this table.
- "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "projectId": "A String", # The ID of the project to which the table belongs.
- "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
- "A String",
- ],
- "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
- "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
- "etag": "A String", # The ETag, used to refer to the current version of the asset.
- "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
- "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
- 3.14,
- ],
- "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
- "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
- "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
- "id": "A String", # A globally unique ID, used to refer to this table.
- "name": "A String", # The name of this table, supplied by the author.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.tables.parents.html b/docs/dyn/mapsengine_v1.tables.parents.html
deleted file mode 100644
index d37fc93..0000000
--- a/docs/dyn/mapsengine_v1.tables.parents.html
+++ /dev/null
@@ -1,120 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.tables.html">tables</a> . <a href="mapsengine_v1.tables.parents.html">parents</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(id, pageToken=None, maxResults=None)</a></code></p>
-<p class="firstline">Return all parent ids of the specified table.</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(id, pageToken=None, maxResults=None)</code>
- <pre>Return all parent ids of the specified table.
-
-Args:
- id: string, The ID of the table whose parents will be listed. (required)
- pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
- maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 50.
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to parents.List.
- "nextPageToken": "A String", # Next page token.
- "parents": [ # The parent assets.
- { # A list of the parents of an asset.
- "id": "A String", # The ID of this parent.
- },
- ],
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/mapsengine_v1.tables.permissions.html b/docs/dyn/mapsengine_v1.tables.permissions.html
deleted file mode 100644
index 8daf3e9..0000000
--- a/docs/dyn/mapsengine_v1.tables.permissions.html
+++ /dev/null
@@ -1,162 +0,0 @@
-<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.tables.html">tables</a> . <a href="mapsengine_v1.tables.permissions.html">permissions</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#batchDelete">batchDelete(id, body)</a></code></p>
-<p class="firstline">Remove permission entries from an already existing asset.</p>
-<p class="toc_element">
- <code><a href="#batchUpdate">batchUpdate(id, body)</a></code></p>
-<p class="firstline">Add or update permission entries to an already existing asset.</p>
-<p class="toc_element">
- <code><a href="#list">list(id)</a></code></p>
-<p class="firstline">Return all of the permissions for the specified asset.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="batchDelete">batchDelete(id, body)</code>
- <pre>Remove permission entries from an already existing asset.
-
-Args:
- id: string, The ID of the asset from which permissions will be removed. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to mapsengine.permissions.batchDelete.
- "ids": [ # An array of permission ids to be removed. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to mapsengine.permissions.batchDelete.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="batchUpdate">batchUpdate(id, body)</code>
- <pre>Add or update permission entries to an already existing asset.
-
-An asset can hold up to 20 different permission entries. Each batchInsert request is atomic.
-
-Args:
- id: string, The ID of the asset to which permissions will be added. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The request sent to mapsengine.permissions.batchUpdate.
- "permissions": [ # The permissions to be inserted or updated.
- { # A permission defines the user or group that has access to an asset, and the type of access they have.
- "type": "A String", # The account type.
- "role": "A String", # The type of access granted to this user or group.
- "discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
- "id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # The response returned by a call to mapsengine.permissions.batchUpdate.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(id)</code>
- <pre>Return all of the permissions for the specified asset.
-
-Args:
- id: string, The ID of the asset whose permissions will be listed. (required)
-
-Returns:
- An object of the form:
-
- {
- "permissions": [ # The set of permissions associated with this asset.
- { # A permission defines the user or group that has access to an asset, and the type of access they have.
- "type": "A String", # The account type.
- "role": "A String", # The type of access granted to this user or group.
- "discoverable": True or False, # Indicates whether a public asset is listed and can be found via a web search (value true), or is visible only to people who have a link to the asset (value false).
- "id": "A String", # The unique identifier of the permission. This could be the email address of the user or group this permission refers to, or the string "anyone" for public permissions.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/oauth2_v1.html b/docs/dyn/oauth2_v1.html
new file mode 100644
index 0000000..367e0c2
--- /dev/null
+++ b/docs/dyn/oauth2_v1.html
@@ -0,0 +1,244 @@
+<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="oauth2_v1.html">Google OAuth2 API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="oauth2_v1.userinfo.html">userinfo()</a></code>
+</p>
+<p class="firstline">Returns the userinfo Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#getCertForOpenIdConnect">getCertForOpenIdConnect()</a></code></p>
+<p class="firstline">A description of how to use this function</p>
+<p class="toc_element">
+ <code><a href="#getCertForOpenIdConnectRaw">getCertForOpenIdConnectRaw()</a></code></p>
+<p class="firstline">A description of how to use this function</p>
+<p class="toc_element">
+ <code><a href="#getRobotJwk">getRobotJwk(robotEmail)</a></code></p>
+<p class="firstline">A description of how to use this function</p>
+<p class="toc_element">
+ <code><a href="#getRobotMetadataRaw">getRobotMetadataRaw(robotEmail)</a></code></p>
+<p class="firstline">A description of how to use this function</p>
+<p class="toc_element">
+ <code><a href="#getRobotMetadataX509">getRobotMetadataX509(robotEmail)</a></code></p>
+<p class="firstline">A description of how to use this function</p>
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<p class="toc_element">
+ <code><a href="#tokeninfo">tokeninfo(access_token=None, id_token=None)</a></code></p>
+<p class="firstline">Get token info</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="getCertForOpenIdConnect">getCertForOpenIdConnect()</code>
+ <pre>A description of how to use this function
+
+Args:
+
+Returns:
+ An object of the form:
+
+ {
+ "a_key": "A String",
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getCertForOpenIdConnectRaw">getCertForOpenIdConnectRaw()</code>
+ <pre>A description of how to use this function
+
+Args:
+
+Returns:
+ An object of the form:
+
+ {
+ "keyvalues": [
+ {
+ "keyid": "A String",
+ "modulus": "A String",
+ "exponent": "A String",
+ "algorithm": "RSA",
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getRobotJwk">getRobotJwk(robotEmail)</code>
+ <pre>A description of how to use this function
+
+Args:
+ robotEmail: string, The email of robot account. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "keys": [
+ {
+ "use": "sig",
+ "e": "A String",
+ "kty": "RSA",
+ "alg": "RS256",
+ "n": "A String",
+ "kid": "A String",
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getRobotMetadataRaw">getRobotMetadataRaw(robotEmail)</code>
+ <pre>A description of how to use this function
+
+Args:
+ robotEmail: string, The email of robot account. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "keyvalues": [
+ {
+ "keyid": "A String",
+ "modulus": "A String",
+ "exponent": "A String",
+ "algorithm": "RSA",
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getRobotMetadataX509">getRobotMetadataX509(robotEmail)</code>
+ <pre>A description of how to use this function
+
+Args:
+ robotEmail: string, The email of robot account. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "a_key": "A String",
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
+<div class="method">
+ <code class="details" id="tokeninfo">tokeninfo(access_token=None, id_token=None)</code>
+ <pre>Get token info
+
+Args:
+ access_token: string, The oauth2 access token
+ id_token: string, The ID token
+
+Returns:
+ An object of the form:
+
+ {
+ "issued_to": "A String", # To whom was the token issued to. In general the same as audience.
+ "nonce": "A String", # Nonce of the id token.
+ "user_id": "A String", # The obfuscated user id.
+ "email_verified": True or False, # Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.
+ "expires_in": 42, # The expiry time of the token, as number of seconds left until expiry.
+ "access_type": "A String", # The access type granted with this token. It can be offline or online.
+ "audience": "A String", # Who is the intended audience for this token. In general the same as issued_to.
+ "issued_at": 42, # The issue time of the token, as number of seconds.
+ "scope": "A String", # The space separated list of scopes granted to this token.
+ "verified_email": True or False, # Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.
+ "email": "A String", # The email address of the user. Present only if the email scope is present in the request.
+ "issuer": "A String", # Who issued the token.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/oauth2_v1.userinfo.html b/docs/dyn/oauth2_v1.userinfo.html
new file mode 100644
index 0000000..2fa56b1
--- /dev/null
+++ b/docs/dyn/oauth2_v1.userinfo.html
@@ -0,0 +1,110 @@
+<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="oauth2_v1.html">Google OAuth2 API</a> . <a href="oauth2_v1.userinfo.html">userinfo</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="oauth2_v1.userinfo.v2.html">v2()</a></code>
+</p>
+<p class="firstline">Returns the v2 Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#get">get()</a></code></p>
+<p class="firstline">Get user info</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get()</code>
+ <pre>Get user info
+
+Args:
+
+Returns:
+ An object of the form:
+
+ {
+ "family_name": "A String", # The user's last name.
+ "name": "A String", # The user's full name.
+ "picture": "A String", # URL of the user's picture image.
+ "locale": "A String", # The user's preferred locale.
+ "gender": "A String", # The user's gender.
+ "email": "A String", # The user's email address.
+ "link": "A String", # URL of the profile page.
+ "given_name": "A String", # The user's first name.
+ "id": "A String", # The obfuscated ID of the user.
+ "hd": "A String", # The hosted domain e.g. example.com if the user is Google apps user.
+ "verified_email": true, # Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dataflow_v1beta3.v1b3.html b/docs/dyn/oauth2_v1.userinfo.v2.html
similarity index 78%
copy from docs/dyn/dataflow_v1beta3.v1b3.html
copy to docs/dyn/oauth2_v1.userinfo.v2.html
index e81eb27..895b969 100644
--- a/docs/dyn/dataflow_v1beta3.v1b3.html
+++ b/docs/dyn/oauth2_v1.userinfo.v2.html
@@ -72,11 +72,11 @@
</style>
-<h1><a href="dataflow_v1beta3.html">Google Dataflow API</a> . <a href="dataflow_v1beta3.v1b3.html">v1b3</a></h1>
+<h1><a href="oauth2_v1.html">Google OAuth2 API</a> . <a href="oauth2_v1.userinfo.html">userinfo</a> . <a href="oauth2_v1.userinfo.v2.html">v2</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="dataflow_v1beta3.v1b3.projects.html">projects()</a></code>
+ <code><a href="oauth2_v1.userinfo.v2.me.html">me()</a></code>
</p>
-<p class="firstline">Returns the projects Resource.</p>
+<p class="firstline">Returns the me Resource.</p>
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/oauth2_v1.userinfo.v2.me.html b/docs/dyn/oauth2_v1.userinfo.v2.me.html
new file mode 100644
index 0000000..335cfdb
--- /dev/null
+++ b/docs/dyn/oauth2_v1.userinfo.v2.me.html
@@ -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="oauth2_v1.html">Google OAuth2 API</a> . <a href="oauth2_v1.userinfo.html">userinfo</a> . <a href="oauth2_v1.userinfo.v2.html">v2</a> . <a href="oauth2_v1.userinfo.v2.me.html">me</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get()</a></code></p>
+<p class="firstline">Get user info</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get()</code>
+ <pre>Get user info
+
+Args:
+
+Returns:
+ An object of the form:
+
+ {
+ "family_name": "A String", # The user's last name.
+ "name": "A String", # The user's full name.
+ "picture": "A String", # URL of the user's picture image.
+ "locale": "A String", # The user's preferred locale.
+ "gender": "A String", # The user's gender.
+ "email": "A String", # The user's email address.
+ "link": "A String", # URL of the profile page.
+ "given_name": "A String", # The user's first name.
+ "id": "A String", # The obfuscated ID of the user.
+ "hd": "A String", # The hosted domain e.g. example.com if the user is Google apps user.
+ "verified_email": true, # Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.acl.html b/docs/dyn/orkut_v2.acl.html
deleted file mode 100644
index 26005b7..0000000
--- a/docs/dyn/orkut_v2.acl.html
+++ /dev/null
@@ -1,91 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.acl.html">acl</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(activityId, userId)</a></code></p>
-<p class="firstline">Excludes an element from the ACL of the activity.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(activityId, userId)</code>
- <pre>Excludes an element from the ACL of the activity.
-
-Args:
- activityId: string, ID of the activity. (required)
- userId: string, ID of the user to be removed from the activity. (required)
-</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.activities.html b/docs/dyn/orkut_v2.activities.html
deleted file mode 100644
index b0ae2d0..0000000
--- a/docs/dyn/orkut_v2.activities.html
+++ /dev/null
@@ -1,291 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.activities.html">activities</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(activityId)</a></code></p>
-<p class="firstline">Deletes an existing activity, if the access controls allow it.</p>
-<p class="toc_element">
- <code><a href="#list">list(userId, collection, pageToken=None, hl=None, maxResults=None)</a></code></p>
-<p class="firstline">Retrieves a list of activities.</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(activityId)</code>
- <pre>Deletes an existing activity, if the access controls allow it.
-
-Args:
- activityId: string, ID of the activity to remove. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(userId, collection, pageToken=None, hl=None, maxResults=None)</code>
- <pre>Retrieves a list of activities.
-
-Args:
- userId: string, The ID of the user whose activities will be listed. Can be me to refer to the viewer (i.e. the authenticated user). (required)
- collection: string, The collection of activities to list. (required)
- Allowed values
- all - All activities created by the specified user that the authenticated user is authorized to view.
- scraps - The specified user's scrapbook.
- stream - The specified user's stream feed, intended for consumption. This includes activities posted by people that the user is following, and activities in which the user has been mentioned.
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of activities to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in activities.list request to get the next page, if there are more to retrieve.
- "items": [ # List of activities retrieved.
- {
- "kind": "orkut#activity", # The kind of activity. Always orkut#activity.
- "links": [ # Links to resources related to this activity.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "title": "A String", # Title of the activity.
- "object": { # The activity's object.
- "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
- "items": [ # The list of additional items.
- {
- "displayName": "A String", # The title of the object.
- "links": [ # Links to other resources related to this object.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "community": { # The community which is related with this activity, e.g. a joined community.
- "category": "A String", # The category of the community.
- "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
- "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.
- "description": "A String", # The description of the community.
- "language": "A String", # The official language of the community.
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "creation_date": "A String", # The time the community was created, in RFC 3339 format.
- "owner": { # The person who owns the community.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "moderators": [ # The list of moderators of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "location": "A String", # The location of the community.
- "co_owners": [ # The co-owners of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "photo_url": "A String", # The photo of the community.
- "id": 42, # The id of the community.
- "name": "A String", # The name of the community.
- },
- "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
- "person": { # The person who is related with this activity, e.g. an Added User.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "id": "A String", # The ID for the object.
- "objectType": "A String", # The object type.
- },
- ],
- "replies": { # Comments in reply to this activity.
- "totalItems": "A String", # Total number of comments.
- "items": [ # The list of comments.
- {
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
- },
- ],
- "url": "A String", # URL for the collection of comments in reply to this activity.
- },
- "objectType": "A String", # The type of the object affected by the activity. Clients can use this information to style the rendered activity object differently depending on the content.
- },
- "updated": "A String", # The time at which the activity was last updated.
- "actor": { # The person who performed the activity.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "access": { # Identifies who has access to see this activity.
- "items": [ # The list of ACL entries.
- {
- "type": "A String", # The type of entity to whom access is granted.
- "id": "A String", # The ID of the entity. For entities of type "person" or "circle", this is the ID of the resource. For other types, this will be unset.
- },
- ],
- "kind": "orkut#acl", # Identifies this resource as an access control list. Value: "orkut#acl"
- "description": "A String", # Human readable description of the access granted.
- "totalParticipants": 42, # The total count of participants of the parent resource.
- },
- "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
- # - add - User added new content to profile or album, e.g. video, photo.
- # - post - User publish content to the stream, e.g. status, scrap.
- # - update - User commented on an activity.
- # - make-friend - User added a new friend.
- # - birthday - User has a birthday.
- "published": "A String", # The time at which the activity was initially published.
- "id": "A String", # The ID for the activity.
- },
- ],
- "kind": "orkut#activityList", # Identifies this resource as a collection of activities. Value: "orkut#activityList"
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.activityVisibility.html b/docs/dyn/orkut_v2.activityVisibility.html
deleted file mode 100644
index c41949a..0000000
--- a/docs/dyn/orkut_v2.activityVisibility.html
+++ /dev/null
@@ -1,201 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.activityVisibility.html">activityVisibility</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(activityId)</a></code></p>
-<p class="firstline">Gets the visibility of an existing activity.</p>
-<p class="toc_element">
- <code><a href="#patch">patch(activityId, body)</a></code></p>
-<p class="firstline">Updates the visibility of an existing activity. This method supports patch semantics.</p>
-<p class="toc_element">
- <code><a href="#update">update(activityId, body)</a></code></p>
-<p class="firstline">Updates the visibility of an existing activity.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(activityId)</code>
- <pre>Gets the visibility of an existing activity.
-
-Args:
- activityId: string, ID of the activity to get the visibility. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
- "visibility": "A String", # The visibility of the resource. Possible values are:
- # - default: not hidden by the user
- # - hidden: hidden
- "links": [ # List of resources for the visibility item.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(activityId, body)</code>
- <pre>Updates the visibility of an existing activity. This method supports patch semantics.
-
-Args:
- activityId: string, ID of the activity. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
- "visibility": "A String", # The visibility of the resource. Possible values are:
- # - default: not hidden by the user
- # - hidden: hidden
- "links": [ # List of resources for the visibility item.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
- "visibility": "A String", # The visibility of the resource. Possible values are:
- # - default: not hidden by the user
- # - hidden: hidden
- "links": [ # List of resources for the visibility item.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(activityId, body)</code>
- <pre>Updates the visibility of an existing activity.
-
-Args:
- activityId: string, ID of the activity. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
- "visibility": "A String", # The visibility of the resource. Possible values are:
- # - default: not hidden by the user
- # - hidden: hidden
- "links": [ # List of resources for the visibility item.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
- "visibility": "A String", # The visibility of the resource. Possible values are:
- # - default: not hidden by the user
- # - hidden: hidden
- "links": [ # List of resources for the visibility item.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.badges.html b/docs/dyn/orkut_v2.badges.html
deleted file mode 100644
index cb9b33d..0000000
--- a/docs/dyn/orkut_v2.badges.html
+++ /dev/null
@@ -1,136 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.badges.html">badges</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(userId, badgeId)</a></code></p>
-<p class="firstline">Retrieves a badge from a user.</p>
-<p class="toc_element">
- <code><a href="#list">list(userId)</a></code></p>
-<p class="firstline">Retrieves the list of visible badges of a user.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(userId, badgeId)</code>
- <pre>Retrieves a badge from a user.
-
-Args:
- userId: string, The ID of the user whose badges will be listed. Can be me to refer to caller. (required)
- badgeId: string, The ID of the badge that will be retrieved. (required)
-
-Returns:
- An object of the form:
-
- {
- "badgeSmallLogo": "A String", # The URL for the 24x24 badge logo.
- "kind": "orkut#badge", # Identifies this resource as a badge. Value: "orkut#badge"
- "description": "A String", # The description for the badge, suitable for display.
- "sponsorLogo": "A String", # The URL for the 32x32 badge sponsor logo.
- "sponsorName": "A String", # The name of the badge sponsor, suitable for display.
- "badgeLargeLogo": "A String", # The URL for the 64x64 badge logo.
- "caption": "A String", # The name of the badge, suitable for display.
- "sponsorUrl": "A String", # The URL for the badge sponsor.
- "id": "A String", # The unique ID for the badge.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(userId)</code>
- <pre>Retrieves the list of visible badges of a user.
-
-Args:
- userId: string, The id of the user whose badges will be listed. Can be me to refer to caller. (required)
-
-Returns:
- An object of the form:
-
- {
- "items": [ # List of badges retrieved.
- {
- "badgeSmallLogo": "A String", # The URL for the 24x24 badge logo.
- "kind": "orkut#badge", # Identifies this resource as a badge. Value: "orkut#badge"
- "description": "A String", # The description for the badge, suitable for display.
- "sponsorLogo": "A String", # The URL for the 32x32 badge sponsor logo.
- "sponsorName": "A String", # The name of the badge sponsor, suitable for display.
- "badgeLargeLogo": "A String", # The URL for the 64x64 badge logo.
- "caption": "A String", # The name of the badge, suitable for display.
- "sponsorUrl": "A String", # The URL for the badge sponsor.
- "id": "A String", # The unique ID for the badge.
- },
- ],
- "kind": "orkut#badgeList", # Identifies this resource as a collection of badges. Value: "orkut#badgeList"
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.comments.html b/docs/dyn/orkut_v2.comments.html
deleted file mode 100644
index a26e441..0000000
--- a/docs/dyn/orkut_v2.comments.html
+++ /dev/null
@@ -1,283 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.comments.html">comments</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(commentId)</a></code></p>
-<p class="firstline">Deletes an existing comment.</p>
-<p class="toc_element">
- <code><a href="#get">get(commentId, hl=None)</a></code></p>
-<p class="firstline">Retrieves an existing comment.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(activityId, body)</a></code></p>
-<p class="firstline">Inserts a new comment to an activity.</p>
-<p class="toc_element">
- <code><a href="#list">list(activityId, orderBy=None, pageToken=None, hl=None, maxResults=None)</a></code></p>
-<p class="firstline">Retrieves a list of comments, possibly filtered.</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(commentId)</code>
- <pre>Deletes an existing comment.
-
-Args:
- commentId: string, ID of the comment to remove. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(commentId, hl=None)</code>
- <pre>Retrieves an existing comment.
-
-Args:
- commentId: string, ID of the comment to get. (required)
- hl: string, Specifies the interface language (host language) of your user interface.
-
-Returns:
- An object of the form:
-
- {
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(activityId, body)</code>
- <pre>Inserts a new comment to an activity.
-
-Args:
- activityId: string, The ID of the activity to contain the new comment. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
-}
-
-
-Returns:
- An object of the form:
-
- {
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(activityId, orderBy=None, pageToken=None, hl=None, maxResults=None)</code>
- <pre>Retrieves a list of comments, possibly filtered.
-
-Args:
- activityId: string, The ID of the activity containing the comments. (required)
- orderBy: string, Sort search results.
- Allowed values
- ascending - Use ascending sort order.
- descending - Use descending sort order.
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of activities to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in comments.list request to get the next page, if there are more to retrieve.
- "items": [ # List of comments retrieved.
- {
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
- },
- ],
- "kind": "orkut#commentList", # Identifies this resource as a collection of comments. Value: "orkut#commentList"
- "previousPageToken": "A String", # The value of pageToken query parameter in comments.list request to get the previous page, if there are more to retrieve.
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.communities.html b/docs/dyn/orkut_v2.communities.html
deleted file mode 100644
index ef4c659..0000000
--- a/docs/dyn/orkut_v2.communities.html
+++ /dev/null
@@ -1,216 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.communities.html">communities</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(communityId, hl=None)</a></code></p>
-<p class="firstline">Retrieves the basic information (aka. profile) of a community.</p>
-<p class="toc_element">
- <code><a href="#list">list(userId, orderBy=None, hl=None, maxResults=None)</a></code></p>
-<p class="firstline">Retrieves the list of communities the current user is a member of.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="get">get(communityId, hl=None)</code>
- <pre>Retrieves the basic information (aka. profile) of a community.
-
-Args:
- communityId: integer, The ID of the community to get. (required)
- hl: string, Specifies the interface language (host language) of your user interface.
-
-Returns:
- An object of the form:
-
- {
- "category": "A String", # The category of the community.
- "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
- "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.
- "description": "A String", # The description of the community.
- "language": "A String", # The official language of the community.
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "creation_date": "A String", # The time the community was created, in RFC 3339 format.
- "owner": { # The person who owns the community.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "moderators": [ # The list of moderators of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "location": "A String", # The location of the community.
- "co_owners": [ # The co-owners of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "photo_url": "A String", # The photo of the community.
- "id": 42, # The id of the community.
- "name": "A String", # The name of the community.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(userId, orderBy=None, hl=None, maxResults=None)</code>
- <pre>Retrieves the list of communities the current user is a member of.
-
-Args:
- userId: string, The ID of the user whose communities will be listed. Can be me to refer to caller. (required)
- orderBy: string, How to order the communities by.
- Allowed values
- id - Returns the communities sorted by a fixed, natural order.
- ranked - Returns the communities ranked accordingly to how they are displayed on the orkut web application.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of communities to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # List of communities retrieved.
- {
- "category": "A String", # The category of the community.
- "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
- "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.
- "description": "A String", # The description of the community.
- "language": "A String", # The official language of the community.
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "creation_date": "A String", # The time the community was created, in RFC 3339 format.
- "owner": { # The person who owns the community.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "moderators": [ # The list of moderators of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "location": "A String", # The location of the community.
- "co_owners": [ # The co-owners of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "photo_url": "A String", # The photo of the community.
- "id": 42, # The id of the community.
- "name": "A String", # The name of the community.
- },
- ],
- "kind": "orkut#communityList", # Identifies this resource as a collection of communities. Value: "orkut#communityList"
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.communityFollow.html b/docs/dyn/orkut_v2.communityFollow.html
deleted file mode 100644
index 2002c14..0000000
--- a/docs/dyn/orkut_v2.communityFollow.html
+++ /dev/null
@@ -1,136 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.communityFollow.html">communityFollow</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(communityId, userId)</a></code></p>
-<p class="firstline">Removes a user from the followers of a community.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(communityId, userId)</a></code></p>
-<p class="firstline">Adds a user as a follower of a community.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="delete">delete(communityId, userId)</code>
- <pre>Removes a user from the followers of a community.
-
-Args:
- communityId: integer, ID of the community. (required)
- userId: string, ID of the user. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(communityId, userId)</code>
- <pre>Adds a user as a follower of a community.
-
-Args:
- communityId: integer, ID of the community. (required)
- userId: string, ID of the user. (required)
-
-Returns:
- An object of the form:
-
- {
- "communityMembershipStatus": { # Status and permissions of the user related to the community.
- "status": "A String", # The status of the current link between the community and the user.
- "isFollowing": True or False, # Whether the user is following this community.
- "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
- "isModerator": True or False, # Whether the session user is a community moderator.
- "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
- "isCoOwner": True or False, # Whether the session user is a community co-owner.
- "canCreatePoll": True or False, # Whether the user can create a poll in this community.
- "canShout": True or False, # Whether the user can perform a shout operation in this community.
- "isOwner": True or False, # Whether the session user is the community owner.
- "canCreateTopic": True or False, # Whether the user can create a topic in this community.
- "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
- },
- "person": { # Description of the community member.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.communityMembers.html b/docs/dyn/orkut_v2.communityMembers.html
deleted file mode 100644
index ae7831d..0000000
--- a/docs/dyn/orkut_v2.communityMembers.html
+++ /dev/null
@@ -1,256 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.communityMembers.html">communityMembers</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(communityId, userId)</a></code></p>
-<p class="firstline">Makes the user leave a community.</p>
-<p class="toc_element">
- <code><a href="#get">get(communityId, userId, hl=None)</a></code></p>
-<p class="firstline">Retrieves the relationship between a user and a community.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(communityId, userId)</a></code></p>
-<p class="firstline">Makes the user join a community.</p>
-<p class="toc_element">
- <code><a href="#list">list(communityId, friendsOnly=None, pageToken=None, hl=None, maxResults=None)</a></code></p>
-<p class="firstline">Lists members of a community. Use the pagination tokens to retrieve the full list; do not rely on the member count available in the community profile information to know when to stop iterating, as that count may be approximate.</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(communityId, userId)</code>
- <pre>Makes the user leave a community.
-
-Args:
- communityId: integer, ID of the community. (required)
- userId: string, ID of the user. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(communityId, userId, hl=None)</code>
- <pre>Retrieves the relationship between a user and a community.
-
-Args:
- communityId: integer, ID of the community. (required)
- userId: string, ID of the user. (required)
- hl: string, Specifies the interface language (host language) of your user interface.
-
-Returns:
- An object of the form:
-
- {
- "communityMembershipStatus": { # Status and permissions of the user related to the community.
- "status": "A String", # The status of the current link between the community and the user.
- "isFollowing": True or False, # Whether the user is following this community.
- "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
- "isModerator": True or False, # Whether the session user is a community moderator.
- "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
- "isCoOwner": True or False, # Whether the session user is a community co-owner.
- "canCreatePoll": True or False, # Whether the user can create a poll in this community.
- "canShout": True or False, # Whether the user can perform a shout operation in this community.
- "isOwner": True or False, # Whether the session user is the community owner.
- "canCreateTopic": True or False, # Whether the user can create a topic in this community.
- "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
- },
- "person": { # Description of the community member.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(communityId, userId)</code>
- <pre>Makes the user join a community.
-
-Args:
- communityId: integer, ID of the community. (required)
- userId: string, ID of the user. (required)
-
-Returns:
- An object of the form:
-
- {
- "communityMembershipStatus": { # Status and permissions of the user related to the community.
- "status": "A String", # The status of the current link between the community and the user.
- "isFollowing": True or False, # Whether the user is following this community.
- "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
- "isModerator": True or False, # Whether the session user is a community moderator.
- "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
- "isCoOwner": True or False, # Whether the session user is a community co-owner.
- "canCreatePoll": True or False, # Whether the user can create a poll in this community.
- "canShout": True or False, # Whether the user can perform a shout operation in this community.
- "isOwner": True or False, # Whether the session user is the community owner.
- "canCreateTopic": True or False, # Whether the user can create a topic in this community.
- "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
- },
- "person": { # Description of the community member.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(communityId, friendsOnly=None, pageToken=None, hl=None, maxResults=None)</code>
- <pre>Lists members of a community. Use the pagination tokens to retrieve the full list; do not rely on the member count available in the community profile information to know when to stop iterating, as that count may be approximate.
-
-Args:
- communityId: integer, The ID of the community whose members will be listed. (required)
- friendsOnly: boolean, Whether to list only community members who are friends of the user.
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of members to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the next page, if there are more to retrieve.
- "kind": "orkut#communityMembersList", # Kind of this item. Always orkut#communityMembersList.
- "items": [ # List of community members retrieved.
- {
- "communityMembershipStatus": { # Status and permissions of the user related to the community.
- "status": "A String", # The status of the current link between the community and the user.
- "isFollowing": True or False, # Whether the user is following this community.
- "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
- "isModerator": True or False, # Whether the session user is a community moderator.
- "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
- "isCoOwner": True or False, # Whether the session user is a community co-owner.
- "canCreatePoll": True or False, # Whether the user can create a poll in this community.
- "canShout": True or False, # Whether the user can perform a shout operation in this community.
- "isOwner": True or False, # Whether the session user is the community owner.
- "canCreateTopic": True or False, # Whether the user can create a topic in this community.
- "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
- },
- "person": { # Description of the community member.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
- },
- ],
- "prevPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the previous page, if there are more to retrieve.
- "lastPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the last page.
- "firstPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the first page.
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.communityMessages.html b/docs/dyn/orkut_v2.communityMessages.html
deleted file mode 100644
index 158ed0e..0000000
--- a/docs/dyn/orkut_v2.communityMessages.html
+++ /dev/null
@@ -1,229 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.communityMessages.html">communityMessages</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(communityId, topicId, messageId)</a></code></p>
-<p class="firstline">Moves a message of the community to the trash folder.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(communityId, topicId, body)</a></code></p>
-<p class="firstline">Adds a message to a given community topic.</p>
-<p class="toc_element">
- <code><a href="#list">list(communityId, topicId, pageToken=None, hl=None, maxResults=None)</a></code></p>
-<p class="firstline">Retrieves the messages of a topic of a community.</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(communityId, topicId, messageId)</code>
- <pre>Moves a message of the community to the trash folder.
-
-Args:
- communityId: integer, The ID of the community whose message will be moved to the trash folder. (required)
- topicId: string, The ID of the topic whose message will be moved to the trash folder. (required)
- messageId: string, The ID of the message to be moved to the trash folder. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(communityId, topicId, body)</code>
- <pre>Adds a message to a given community topic.
-
-Args:
- communityId: integer, The ID of the community the message should be added to. (required)
- topicId: string, The ID of the topic the message should be added to. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(communityId, topicId, pageToken=None, hl=None, maxResults=None)</code>
- <pre>Retrieves the messages of a topic of a community.
-
-Args:
- communityId: integer, The ID of the community which messages will be listed. (required)
- topicId: string, The ID of the topic which messages will be listed. (required)
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of messages to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in community_messages.list request to get the next page, if there are more to retrieve.
- "kind": "orkut#communityMessageList", # Identifies this resource as a collection of community messages. Value: "orkut#communityMessageList"
- "items": [ # List of messages retrieved.
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- },
- ],
- "prevPageToken": "A String", # The value of pageToken query parameter in community_messages.list request to get the previous page, if there are more to retrieve.
- "lastPageToken": "A String", # The value of pageToken query parameter in community_messages.list request to get the last page.
- "firstPageToken": "A String", # The value of pageToken query parameter in community_messages.list request to get the first page.
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.communityPollComments.html b/docs/dyn/orkut_v2.communityPollComments.html
deleted file mode 100644
index efeff4a..0000000
--- a/docs/dyn/orkut_v2.communityPollComments.html
+++ /dev/null
@@ -1,185 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.communityPollComments.html">communityPollComments</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#insert">insert(communityId, pollId, body)</a></code></p>
-<p class="firstline">Adds a comment on a community poll.</p>
-<p class="toc_element">
- <code><a href="#list">list(communityId, pollId, pageToken=None, hl=None, maxResults=None)</a></code></p>
-<p class="firstline">Retrieves the comments of a community poll.</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="insert">insert(communityId, pollId, body)</code>
- <pre>Adds a comment on a community poll.
-
-Args:
- communityId: integer, The ID of the community whose poll is being commented. (required)
- pollId: string, The ID of the poll being commented. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "body": "A String", # The body of the message.
- "kind": "orkut#communityPollComment", # Identifies this resource as a community poll comment. Value: "orkut#communityPollComment"
- "addedDate": "A String", # The date when the message was added, in RFC 3339 format.
- "id": 42, # The ID of the comment.
- "author": { # The creator of the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityPollComment", # Identifies this resource as a community poll comment. Value: "orkut#communityPollComment"
- "addedDate": "A String", # The date when the message was added, in RFC 3339 format.
- "id": 42, # The ID of the comment.
- "author": { # The creator of the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(communityId, pollId, pageToken=None, hl=None, maxResults=None)</code>
- <pre>Retrieves the comments of a community poll.
-
-Args:
- communityId: integer, The ID of the community whose poll is having its comments listed. (required)
- pollId: string, The ID of the community whose polls will be listed. (required)
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of comments to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in community_poll_comments.list request to get the next page, if there are more to retrieve.
- "kind": "orkut#CommunityPollCommentList", # Identifies this resource as a collection of community poll comments. Value: "orkut#CommunityPollCommentList"
- "items": [ # List of community poll comments retrieved.
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityPollComment", # Identifies this resource as a community poll comment. Value: "orkut#communityPollComment"
- "addedDate": "A String", # The date when the message was added, in RFC 3339 format.
- "id": 42, # The ID of the comment.
- "author": { # The creator of the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- },
- ],
- "prevPageToken": "A String", # The value of pageToken query parameter in community_poll_comments.list request to get the previous page, if there are more to retrieve.
- "lastPageToken": "A String", # The value of pageToken query parameter in community_poll_comments.list request to get the last page.
- "firstPageToken": "A String", # The value of pageToken query parameter in community_poll_comments.list request to get the first page.
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.communityPollVotes.html b/docs/dyn/orkut_v2.communityPollVotes.html
deleted file mode 100644
index 00f5269..0000000
--- a/docs/dyn/orkut_v2.communityPollVotes.html
+++ /dev/null
@@ -1,112 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.communityPollVotes.html">communityPollVotes</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#insert">insert(communityId, pollId, body)</a></code></p>
-<p class="firstline">Votes on a community poll.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="insert">insert(communityId, pollId, body)</code>
- <pre>Votes on a community poll.
-
-Args:
- communityId: integer, The ID of the community whose poll is being voted. (required)
- pollId: string, The ID of the poll being voted. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "orkut#communityPollVote", # Identifies this resource as a community poll vote. Value: "orkut#communityPollVote"
- "optionIds": [ # The ids of the voted options.
- 42,
- ],
- "isVotevisible": True or False, # Whether this vote is visible to other users or not.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "orkut#communityPollVote", # Identifies this resource as a community poll vote. Value: "orkut#communityPollVote"
- "optionIds": [ # The ids of the voted options.
- 42,
- ],
- "isVotevisible": True or False, # Whether this vote is visible to other users or not.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.communityPolls.html b/docs/dyn/orkut_v2.communityPolls.html
deleted file mode 100644
index 03c6824..0000000
--- a/docs/dyn/orkut_v2.communityPolls.html
+++ /dev/null
@@ -1,241 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.communityPolls.html">communityPolls</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#get">get(communityId, pollId, hl=None)</a></code></p>
-<p class="firstline">Retrieves one specific poll of a community.</p>
-<p class="toc_element">
- <code><a href="#list">list(communityId, pageToken=None, hl=None, maxResults=None)</a></code></p>
-<p class="firstline">Retrieves the polls of a community.</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(communityId, pollId, hl=None)</code>
- <pre>Retrieves one specific poll of a community.
-
-Args:
- communityId: integer, The ID of the community for whose poll will be retrieved. (required)
- pollId: string, The ID of the poll to get. (required)
- hl: string, Specifies the interface language (host language) of your user interface.
-
-Returns:
- An object of the form:
-
- {
- "links": [ # List of resources for the community poll.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "isMultipleAnswers": True or False, # Whether this poll allows voting for more than one option.
- "image": { # The image representing the poll. Field is omitted if no image exists.
- "url": "A String", # A URL that points to an image of the poll.
- },
- "endingTime": "A String", # The ending date of this poll or empty if the poll doesn't have one.
- "isVotingAllowedForNonMembers": True or False, # Whether non-members of the community can vote on the poll.
- "isSpam": True or False, # Whether the user has marked this poll as spam. This only affects the poll for this user, not globally.
- "totalNumberOfVotes": 42, # The total number of votes this poll has received.
- "author": { # The person who created the poll.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "question": "A String", # The poll question.
- "id": "A String", # The poll ID.
- "isRestricted": True or False, # Whether this poll is restricted for members only. If a poll is open but the user can't vote on it, it's been restricted to members only. This information is important to tell this case apart from the one where the user can't vote simply because the poll is already closed.
- "communityId": 42, # The ID of the community.
- "isUsersVotePublic": True or False, # If user has already voted, whether his vote is publicly visible.
- "lastUpdate": "A String", # The date of the last update of this poll.
- "description": "A String", # The poll description.
- "votedOptions": [ # List of options the user has voted on, if there are any.
- 42,
- ],
- "isOpenForVoting": True or False, # Whether this poll is still opened for voting. A poll is open for voting if it is not closed, the user has not yet voted on it and the user has the permission to do so, which happens if he/she is either a community member or the poll is open for everybody.
- "isClosed": True or False, # Whether the poll is not expired if there is an expiration date. A poll is open (that is, not closed for voting) if it either is not expired or doesn't have an expiration date at all. Note that just because a poll is open, it doesn't mean that the requester can vote on it.
- "hasVoted": True or False, # Whether the user has voted on this poll.
- "kind": "orkut#communityPoll", # Identifies this resource as a community poll. Value: "orkut#communityPoll"
- "creationTime": "A String", # The date of creation of this poll
- "options": [ # List of options of this poll.
- {
- "image": { # Image data about the poll option. Field is omitted if no image exists.
- "url": "A String", # A URL that points to an image of the poll question.
- },
- "optionId": 42, # The poll option ID
- "description": "A String", # The option description.
- "numberOfVotes": 42, # The total number of votes that this option received.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(communityId, pageToken=None, hl=None, maxResults=None)</code>
- <pre>Retrieves the polls of a community.
-
-Args:
- communityId: integer, The ID of the community which polls will be listed. (required)
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of polls to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in community_polls.list request to get the next page, if there are more to retrieve.
- "kind": "orkut#communityPollList", # Identifies this resource as a collection of community polls. Value: "orkut#communityPollList"
- "items": [ # List of community polls retrieved.
- {
- "links": [ # List of resources for the community poll.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "isMultipleAnswers": True or False, # Whether this poll allows voting for more than one option.
- "image": { # The image representing the poll. Field is omitted if no image exists.
- "url": "A String", # A URL that points to an image of the poll.
- },
- "endingTime": "A String", # The ending date of this poll or empty if the poll doesn't have one.
- "isVotingAllowedForNonMembers": True or False, # Whether non-members of the community can vote on the poll.
- "isSpam": True or False, # Whether the user has marked this poll as spam. This only affects the poll for this user, not globally.
- "totalNumberOfVotes": 42, # The total number of votes this poll has received.
- "author": { # The person who created the poll.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "question": "A String", # The poll question.
- "id": "A String", # The poll ID.
- "isRestricted": True or False, # Whether this poll is restricted for members only. If a poll is open but the user can't vote on it, it's been restricted to members only. This information is important to tell this case apart from the one where the user can't vote simply because the poll is already closed.
- "communityId": 42, # The ID of the community.
- "isUsersVotePublic": True or False, # If user has already voted, whether his vote is publicly visible.
- "lastUpdate": "A String", # The date of the last update of this poll.
- "description": "A String", # The poll description.
- "votedOptions": [ # List of options the user has voted on, if there are any.
- 42,
- ],
- "isOpenForVoting": True or False, # Whether this poll is still opened for voting. A poll is open for voting if it is not closed, the user has not yet voted on it and the user has the permission to do so, which happens if he/she is either a community member or the poll is open for everybody.
- "isClosed": True or False, # Whether the poll is not expired if there is an expiration date. A poll is open (that is, not closed for voting) if it either is not expired or doesn't have an expiration date at all. Note that just because a poll is open, it doesn't mean that the requester can vote on it.
- "hasVoted": True or False, # Whether the user has voted on this poll.
- "kind": "orkut#communityPoll", # Identifies this resource as a community poll. Value: "orkut#communityPoll"
- "creationTime": "A String", # The date of creation of this poll
- "options": [ # List of options of this poll.
- {
- "image": { # Image data about the poll option. Field is omitted if no image exists.
- "url": "A String", # A URL that points to an image of the poll question.
- },
- "optionId": 42, # The poll option ID
- "description": "A String", # The option description.
- "numberOfVotes": 42, # The total number of votes that this option received.
- },
- ],
- },
- ],
- "prevPageToken": "A String", # The value of pageToken query parameter in community_polls.list request to get the previous page, if there are more to retrieve.
- "lastPageToken": "A String", # The value of pageToken query parameter in community_polls.list request to get the last page.
- "firstPageToken": "A String", # The value of pageToken query parameter in community_polls.list request to get the first page.
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.communityRelated.html b/docs/dyn/orkut_v2.communityRelated.html
deleted file mode 100644
index bf7752b..0000000
--- a/docs/dyn/orkut_v2.communityRelated.html
+++ /dev/null
@@ -1,147 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.communityRelated.html">communityRelated</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(communityId, hl=None)</a></code></p>
-<p class="firstline">Retrieves the communities related to another one.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(communityId, hl=None)</code>
- <pre>Retrieves the communities related to another one.
-
-Args:
- communityId: integer, The ID of the community whose related communities will be listed. (required)
- hl: string, Specifies the interface language (host language) of your user interface.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # List of communities retrieved.
- {
- "category": "A String", # The category of the community.
- "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
- "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.
- "description": "A String", # The description of the community.
- "language": "A String", # The official language of the community.
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "creation_date": "A String", # The time the community was created, in RFC 3339 format.
- "owner": { # The person who owns the community.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "moderators": [ # The list of moderators of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "location": "A String", # The location of the community.
- "co_owners": [ # The co-owners of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "photo_url": "A String", # The photo of the community.
- "id": 42, # The id of the community.
- "name": "A String", # The name of the community.
- },
- ],
- "kind": "orkut#communityList", # Identifies this resource as a collection of communities. Value: "orkut#communityList"
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.communityTopics.html b/docs/dyn/orkut_v2.communityTopics.html
deleted file mode 100644
index 1a6046e..0000000
--- a/docs/dyn/orkut_v2.communityTopics.html
+++ /dev/null
@@ -1,380 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.communityTopics.html">communityTopics</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#delete">delete(communityId, topicId)</a></code></p>
-<p class="firstline">Moves a topic of the community to the trash folder.</p>
-<p class="toc_element">
- <code><a href="#get">get(communityId, topicId, hl=None)</a></code></p>
-<p class="firstline">Retrieves a topic of a community.</p>
-<p class="toc_element">
- <code><a href="#insert">insert(communityId, body, isShout=None)</a></code></p>
-<p class="firstline">Adds a topic to a given community.</p>
-<p class="toc_element">
- <code><a href="#list">list(communityId, pageToken=None, hl=None, maxResults=None)</a></code></p>
-<p class="firstline">Retrieves the topics of a community.</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(communityId, topicId)</code>
- <pre>Moves a topic of the community to the trash folder.
-
-Args:
- communityId: integer, The ID of the community whose topic will be moved to the trash folder. (required)
- topicId: string, The ID of the topic to be moved to the trash folder. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(communityId, topicId, hl=None)</code>
- <pre>Retrieves a topic of a community.
-
-Args:
- communityId: integer, The ID of the community whose topic will be retrieved. (required)
- topicId: string, The ID of the topic to get. (required)
- hl: string, Specifies the interface language (host language) of your user interface.
-
-Returns:
- An object of the form:
-
- {
- "body": "A String", # The body of the topic.
- "lastUpdate": "A String", # The timestamp of the last update, in RFC 3339 format.
- "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the topic.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "title": "A String", # The title of the topic.
- "messages": [ # Most recent messages.
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- },
- ],
- "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.
- "isClosed": True or False, # Whether the topic is closed for new messages.
- "numberOfReplies": 42, # The total number of replies this topic has received.
- "id": "A String", # The ID of the topic.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="insert">insert(communityId, body, isShout=None)</code>
- <pre>Adds a topic to a given community.
-
-Args:
- communityId: integer, The ID of the community the topic should be added to. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "body": "A String", # The body of the topic.
- "lastUpdate": "A String", # The timestamp of the last update, in RFC 3339 format.
- "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the topic.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "title": "A String", # The title of the topic.
- "messages": [ # Most recent messages.
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- },
- ],
- "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.
- "isClosed": True or False, # Whether the topic is closed for new messages.
- "numberOfReplies": 42, # The total number of replies this topic has received.
- "id": "A String", # The ID of the topic.
- }
-
- isShout: boolean, Whether this topic is a shout.
-
-Returns:
- An object of the form:
-
- {
- "body": "A String", # The body of the topic.
- "lastUpdate": "A String", # The timestamp of the last update, in RFC 3339 format.
- "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the topic.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "title": "A String", # The title of the topic.
- "messages": [ # Most recent messages.
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- },
- ],
- "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.
- "isClosed": True or False, # Whether the topic is closed for new messages.
- "numberOfReplies": 42, # The total number of replies this topic has received.
- "id": "A String", # The ID of the topic.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(communityId, pageToken=None, hl=None, maxResults=None)</code>
- <pre>Retrieves the topics of a community.
-
-Args:
- communityId: integer, The ID of the community which topics will be listed. (required)
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of topics to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the next page, if there are more to retrieve.
- "kind": "orkut#communityTopicList", # Identifies this resource as a collection of community topics. Value: "orkut#communityTopicList"
- "items": [ # List of topics retrieved.
- {
- "body": "A String", # The body of the topic.
- "lastUpdate": "A String", # The timestamp of the last update, in RFC 3339 format.
- "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the topic.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "title": "A String", # The title of the topic.
- "messages": [ # Most recent messages.
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- },
- ],
- "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.
- "isClosed": True or False, # Whether the topic is closed for new messages.
- "numberOfReplies": 42, # The total number of replies this topic has received.
- "id": "A String", # The ID of the topic.
- },
- ],
- "prevPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the previous page, if there are more to retrieve.
- "lastPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the last page.
- "firstPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the first page.
- }</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>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.counters.html b/docs/dyn/orkut_v2.counters.html
deleted file mode 100644
index f433265..0000000
--- a/docs/dyn/orkut_v2.counters.html
+++ /dev/null
@@ -1,112 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.counters.html">counters</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#list">list(userId)</a></code></p>
-<p class="firstline">Retrieves the counters of a user.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="list">list(userId)</code>
- <pre>Retrieves the counters of a user.
-
-Args:
- userId: string, The ID of the user whose counters will be listed. Can be me to refer to caller. (required)
-
-Returns:
- An object of the form:
-
- {
- "items": [ # List of counters retrieved.
- {
- "total": 42, # The number of resources on the counted collection.
- "link": { # Links to resources related to the parent object. # Link to the collection being counted.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- "name": "A String", # The name of the counted collection. Currently supported collections are:
- # - scraps - The scraps of the user.
- # - photos - The photos of the user.
- # - videos - The videos of the user.
- # - pendingTestimonials - The pending testimonials of the user.
- },
- ],
- "kind": "orkut#counters", # Identifies this resource as a collection of counters. Value: "orkut#counters"
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.html b/docs/dyn/orkut_v2.html
deleted file mode 100644
index 5d7ad82..0000000
--- a/docs/dyn/orkut_v2.html
+++ /dev/null
@@ -1,157 +0,0 @@
-<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="orkut_v2.html">Orkut API</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="orkut_v2.acl.html">acl()</a></code>
-</p>
-<p class="firstline">Returns the acl Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.activities.html">activities()</a></code>
-</p>
-<p class="firstline">Returns the activities Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.activityVisibility.html">activityVisibility()</a></code>
-</p>
-<p class="firstline">Returns the activityVisibility Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.badges.html">badges()</a></code>
-</p>
-<p class="firstline">Returns the badges Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.comments.html">comments()</a></code>
-</p>
-<p class="firstline">Returns the comments Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.communities.html">communities()</a></code>
-</p>
-<p class="firstline">Returns the communities Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.communityFollow.html">communityFollow()</a></code>
-</p>
-<p class="firstline">Returns the communityFollow Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.communityMembers.html">communityMembers()</a></code>
-</p>
-<p class="firstline">Returns the communityMembers Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.communityMessages.html">communityMessages()</a></code>
-</p>
-<p class="firstline">Returns the communityMessages Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.communityPollComments.html">communityPollComments()</a></code>
-</p>
-<p class="firstline">Returns the communityPollComments Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.communityPollVotes.html">communityPollVotes()</a></code>
-</p>
-<p class="firstline">Returns the communityPollVotes Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.communityPolls.html">communityPolls()</a></code>
-</p>
-<p class="firstline">Returns the communityPolls Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.communityRelated.html">communityRelated()</a></code>
-</p>
-<p class="firstline">Returns the communityRelated Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.communityTopics.html">communityTopics()</a></code>
-</p>
-<p class="firstline">Returns the communityTopics Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.counters.html">counters()</a></code>
-</p>
-<p class="firstline">Returns the counters Resource.</p>
-
-<p class="toc_element">
- <code><a href="orkut_v2.scraps.html">scraps()</a></code>
-</p>
-<p class="firstline">Returns the scraps Resource.</p>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.scraps.html b/docs/dyn/orkut_v2.scraps.html
deleted file mode 100644
index 3aff5dc..0000000
--- a/docs/dyn/orkut_v2.scraps.html
+++ /dev/null
@@ -1,406 +0,0 @@
-<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="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.scraps.html">scraps</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#insert">insert(body)</a></code></p>
-<p class="firstline">Creates a new scrap.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="insert">insert(body)</code>
- <pre>Creates a new scrap.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "orkut#activity", # The kind of activity. Always orkut#activity.
- "links": [ # Links to resources related to this activity.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "title": "A String", # Title of the activity.
- "object": { # The activity's object.
- "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
- "items": [ # The list of additional items.
- {
- "displayName": "A String", # The title of the object.
- "links": [ # Links to other resources related to this object.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "community": { # The community which is related with this activity, e.g. a joined community.
- "category": "A String", # The category of the community.
- "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
- "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.
- "description": "A String", # The description of the community.
- "language": "A String", # The official language of the community.
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "creation_date": "A String", # The time the community was created, in RFC 3339 format.
- "owner": { # The person who owns the community.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "moderators": [ # The list of moderators of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "location": "A String", # The location of the community.
- "co_owners": [ # The co-owners of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "photo_url": "A String", # The photo of the community.
- "id": 42, # The id of the community.
- "name": "A String", # The name of the community.
- },
- "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
- "person": { # The person who is related with this activity, e.g. an Added User.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "id": "A String", # The ID for the object.
- "objectType": "A String", # The object type.
- },
- ],
- "replies": { # Comments in reply to this activity.
- "totalItems": "A String", # Total number of comments.
- "items": [ # The list of comments.
- {
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
- },
- ],
- "url": "A String", # URL for the collection of comments in reply to this activity.
- },
- "objectType": "A String", # The type of the object affected by the activity. Clients can use this information to style the rendered activity object differently depending on the content.
- },
- "updated": "A String", # The time at which the activity was last updated.
- "actor": { # The person who performed the activity.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "access": { # Identifies who has access to see this activity.
- "items": [ # The list of ACL entries.
- {
- "type": "A String", # The type of entity to whom access is granted.
- "id": "A String", # The ID of the entity. For entities of type "person" or "circle", this is the ID of the resource. For other types, this will be unset.
- },
- ],
- "kind": "orkut#acl", # Identifies this resource as an access control list. Value: "orkut#acl"
- "description": "A String", # Human readable description of the access granted.
- "totalParticipants": 42, # The total count of participants of the parent resource.
- },
- "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
- # - add - User added new content to profile or album, e.g. video, photo.
- # - post - User publish content to the stream, e.g. status, scrap.
- # - update - User commented on an activity.
- # - make-friend - User added a new friend.
- # - birthday - User has a birthday.
- "published": "A String", # The time at which the activity was initially published.
- "id": "A String", # The ID for the activity.
-}
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "orkut#activity", # The kind of activity. Always orkut#activity.
- "links": [ # Links to resources related to this activity.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "title": "A String", # Title of the activity.
- "object": { # The activity's object.
- "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
- "items": [ # The list of additional items.
- {
- "displayName": "A String", # The title of the object.
- "links": [ # Links to other resources related to this object.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "community": { # The community which is related with this activity, e.g. a joined community.
- "category": "A String", # The category of the community.
- "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
- "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.
- "description": "A String", # The description of the community.
- "language": "A String", # The official language of the community.
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "creation_date": "A String", # The time the community was created, in RFC 3339 format.
- "owner": { # The person who owns the community.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "moderators": [ # The list of moderators of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "location": "A String", # The location of the community.
- "co_owners": [ # The co-owners of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "photo_url": "A String", # The photo of the community.
- "id": 42, # The id of the community.
- "name": "A String", # The name of the community.
- },
- "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
- "person": { # The person who is related with this activity, e.g. an Added User.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "id": "A String", # The ID for the object.
- "objectType": "A String", # The object type.
- },
- ],
- "replies": { # Comments in reply to this activity.
- "totalItems": "A String", # Total number of comments.
- "items": [ # The list of comments.
- {
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
- },
- ],
- "url": "A String", # URL for the collection of comments in reply to this activity.
- },
- "objectType": "A String", # The type of the object affected by the activity. Clients can use this information to style the rendered activity object differently depending on the content.
- },
- "updated": "A String", # The time at which the activity was last updated.
- "actor": { # The person who performed the activity.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "access": { # Identifies who has access to see this activity.
- "items": [ # The list of ACL entries.
- {
- "type": "A String", # The type of entity to whom access is granted.
- "id": "A String", # The ID of the entity. For entities of type "person" or "circle", this is the ID of the resource. For other types, this will be unset.
- },
- ],
- "kind": "orkut#acl", # Identifies this resource as an access control list. Value: "orkut#acl"
- "description": "A String", # Human readable description of the access granted.
- "totalParticipants": 42, # The total count of participants of the parent resource.
- },
- "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
- # - add - User added new content to profile or album, e.g. video, photo.
- # - post - User publish content to the stream, e.g. status, scrap.
- # - update - User commented on an activity.
- # - make-friend - User added a new friend.
- # - birthday - User has a birthday.
- "published": "A String", # The time at which the activity was initially published.
- "id": "A String", # The ID for the activity.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/pagespeedonline_v1.html b/docs/dyn/pagespeedonline_v1.html
index 4b0abf3..8ef8f39 100644
--- a/docs/dyn/pagespeedonline_v1.html
+++ b/docs/dyn/pagespeedonline_v1.html
@@ -79,4 +79,25 @@
</p>
<p class="firstline">Returns the pagespeedapi Resource.</p>
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/pagespeedonline_v1.pagespeedapi.html b/docs/dyn/pagespeedonline_v1.pagespeedapi.html
index 129f17a..a2a60a7 100644
--- a/docs/dyn/pagespeedonline_v1.pagespeedapi.html
+++ b/docs/dyn/pagespeedonline_v1.pagespeedapi.html
@@ -76,17 +76,17 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#runpagespeed">runpagespeed(url, screenshot=None, locale=None, rule=None, strategy=None, filter_third_party_resources=None)</a></code></p>
-<p class="firstline">Runs Page Speed analysis on the page at the specified URL, and returns a Page Speed score, a list of suggestions to make that page faster, and other information.</p>
+<p class="firstline">Runs PageSpeed analysis on the page at the specified URL, and returns a PageSpeed score, a list of suggestions to make that page faster, and other information.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="runpagespeed">runpagespeed(url, screenshot=None, locale=None, rule=None, strategy=None, filter_third_party_resources=None)</code>
- <pre>Runs Page Speed analysis on the page at the specified URL, and returns a Page Speed score, a list of suggestions to make that page faster, and other information.
+ <pre>Runs PageSpeed analysis on the page at the specified URL, and returns a PageSpeed score, a list of suggestions to make that page faster, and other information.
Args:
url: string, The URL to fetch and analyze (required)
screenshot: boolean, Indicates if binary data containing a screenshot should be included
locale: string, The locale used to localize formatted results
- rule: string, A Page Speed rule to run; if none are given, all rules are run (repeated)
+ rule: string, A PageSpeed rule to run; if none are given, all rules are run (repeated)
strategy: string, The analysis strategy to use
Allowed values
desktop - Fetch and analyze the URL for desktop browsers
@@ -98,9 +98,9 @@
{
"kind": "pagespeedonline#result", # Kind of result.
- "formattedResults": { # Localized Page Speed results. Contains a ruleResults entry for each Page Speed rule instantiated and run by the server.
+ "formattedResults": { # Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server.
"locale": "A String", # The locale of the formattedResults, e.g. "en_US".
- "ruleResults": { # Dictionary of formatted rule results, with one entry for each Page Speed rule instantiated and run by the server.
+ "ruleResults": { # Dictionary of formatted rule results, with one entry for each PageSpeed rule instantiated and run by the server.
"a_key": { # The enum-like identifier for this rule. For instance "EnableKeepAlive" or "AvoidCssImport". Not localized.
"localizedRuleName": "A String", # Localized name of the rule, intended for presentation to a user.
"urlBlocks": [ # List of blocks of URLs. Each block may contain a heading and a list of URLs. Each URL may optionally include additional details.
@@ -144,18 +144,18 @@
},
},
},
- "screenshot": { # Base64 encoded screenshot of the page that was analyzed.
+ "screenshot": { # Base64-encoded screenshot of the page that was analyzed.
"width": 42, # Width of screenshot in pixels.
"data": "A String", # Image data base64 encoded.
"mime_type": "A String", # Mime type of image data. E.g. "image/jpeg".
"height": 42, # Height of screenshot in pixels.
},
"title": "A String", # Title of the page, as displayed in the browser's title bar.
- "version": { # The version of the Page Speed SDK used to generate these results.
- "major": 42, # The major version number of the Page Speed SDK used to generate these results.
- "minor": 42, # The minor version number of the Page Speed SDK used to generate these results.
+ "version": { # The version of PageSpeed used to generate these results.
+ "major": 42, # The major version number of PageSpeed used to generate these results.
+ "minor": 42, # The minor version number of PageSpeed used to generate these results.
},
- "score": 42, # The Page Speed Score (0-100), which indicates how much faster a page could be. A high score indicates little room for improvement, while a lower score indicates more room for improvement.
+ "score": 42, # The PageSpeed Score (0-100), which indicates how much faster a page could be. A high score indicates little room for improvement, while a lower score indicates more room for improvement.
"responseCode": 42, # Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error.
"invalidRules": [ # List of rules that were specified in the request, but which the server did not know how to instantiate.
"A String",
diff --git a/docs/dyn/plus_v1.moments.html b/docs/dyn/plus_v1.moments.html
deleted file mode 100644
index 9670004..0000000
--- a/docs/dyn/plus_v1.moments.html
+++ /dev/null
@@ -1,802 +0,0 @@
-<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="plus_v1.html">Google+ API</a> . <a href="plus_v1.moments.html">moments</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#insert">insert(userId, collection, body, debug=None)</a></code></p>
-<p class="firstline">Record a moment representing a user's action such as making a purchase or commenting on a blog.</p>
-<p class="toc_element">
- <code><a href="#list">list(userId, collection, pageToken=None, maxResults=None, targetUrl=None, type=None)</a></code></p>
-<p class="firstline">List all of the moments for a particular user.</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="#remove">remove(id)</a></code></p>
-<p class="firstline">Delete a moment.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="insert">insert(userId, collection, body, debug=None)</code>
- <pre>Record a moment representing a user's action such as making a purchase or commenting on a blog.
-
-Args:
- userId: string, The ID of the user to record actions for. The only valid values are "me" and the ID of the authenticated user. (required)
- collection: string, The collection to which to write moments. (required)
- Allowed values
- vault - The default collection for writing new moments.
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "startDate": "A String", # Time stamp of when the action occurred in RFC3339 format.
- "kind": "plus#moment", # Identifies this resource as a moment.
- "target": { # The object on which the action was performed.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "object": { # The object on which the action was performed. Specifying this is equivalent with specifying "target". Note that responses from the server will use the "target" field instead for backward-compatibility with older clients.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "result": { # The object generated by performing the action on the object. For example, a user writes a review of a restaurant, the object is the restaurant and the result is the review.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "type": "A String", # The schema.org type for the type of moment to write. For example, http://schema.org/AddAction. Note that responses from the server will use the Google schema type instead for backward-compatibility with older clients. For example, http://schemas.google.com/AddActivity.
- "id": "A String", # The moment ID.
- }
-
- debug: boolean, Return the moment as written. Should be used only for debugging.
-
-Returns:
- An object of the form:
-
- {
- "startDate": "A String", # Time stamp of when the action occurred in RFC3339 format.
- "kind": "plus#moment", # Identifies this resource as a moment.
- "target": { # The object on which the action was performed.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "object": { # The object on which the action was performed. Specifying this is equivalent with specifying "target". Note that responses from the server will use the "target" field instead for backward-compatibility with older clients.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "result": { # The object generated by performing the action on the object. For example, a user writes a review of a restaurant, the object is the restaurant and the result is the review.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "type": "A String", # The schema.org type for the type of moment to write. For example, http://schema.org/AddAction. Note that responses from the server will use the Google schema type instead for backward-compatibility with older clients. For example, http://schemas.google.com/AddActivity.
- "id": "A String", # The moment ID.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(userId, collection, pageToken=None, maxResults=None, targetUrl=None, type=None)</code>
- <pre>List all of the moments for a particular user.
-
-Args:
- userId: string, The ID of the user to get moments for. The special value "me" can be used to indicate the authenticated user. (required)
- collection: string, The collection of moments to list. (required)
- Allowed values
- vault - All moments created by the requesting application for the authenticated user.
- pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of moments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
- targetUrl: string, Only moments containing this targetUrl will be returned.
- type: string, Only moments of this type will be returned.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "kind": "plus#momentsFeed", # Identifies this resource as a collection of moments. Value: "plus#momentsFeed".
- "title": "A String", # The title of this collection of moments.
- "items": [ # The moments in this page of results.
- {
- "startDate": "A String", # Time stamp of when the action occurred in RFC3339 format.
- "kind": "plus#moment", # Identifies this resource as a moment.
- "target": { # The object on which the action was performed.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "object": { # The object on which the action was performed. Specifying this is equivalent with specifying "target". Note that responses from the server will use the "target" field instead for backward-compatibility with older clients.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "result": { # The object generated by performing the action on the object. For example, a user writes a review of a restaurant, the object is the restaurant and the result is the review.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "type": "A String", # The schema.org type for the type of moment to write. For example, http://schema.org/AddAction. Note that responses from the server will use the Google schema type instead for backward-compatibility with older clients. For example, http://schemas.google.com/AddActivity.
- "id": "A String", # The moment ID.
- },
- ],
- "updated": "A String", # The RFC 339 timestamp for when this collection of moments was last updated.
- "nextLink": "A String", # Link to the next page of moments.
- "etag": "A String", # ETag of this response for caching purposes.
- "selfLink": "A String", # Link to this page of moments.
- }</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="remove">remove(id)</code>
- <pre>Delete a moment.
-
-Args:
- id: string, The ID of the moment to delete. (required)
-</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/prediction_v1_2.hostedmodels.html b/docs/dyn/prediction_v1_2.hostedmodels.html
new file mode 100644
index 0000000..0c4aeb2
--- /dev/null
+++ b/docs/dyn/prediction_v1_2.hostedmodels.html
@@ -0,0 +1,117 @@
+<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="prediction_v1_2.html">Prediction API</a> . <a href="prediction_v1_2.hostedmodels.html">hostedmodels</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#predict">predict(hostedModelName, body)</a></code></p>
+<p class="firstline">Submit input and request an output against a hosted model</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="predict">predict(hostedModelName, body)</code>
+ <pre>Submit input and request an output against a hosted model
+
+Args:
+ hostedModelName: string, The name of a hosted model (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "input": {
+ "csvInstance": [
+ "",
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#output",
+ "outputLabel": "A String",
+ "id": "A String",
+ "outputMulti": [
+ {
+ "score": 3.14,
+ "label": "A String",
+ },
+ ],
+ "outputValue": 3.14,
+ "selfLink": "A String",
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/coordinate_v1.html b/docs/dyn/prediction_v1_2.html
similarity index 64%
copy from docs/dyn/coordinate_v1.html
copy to docs/dyn/prediction_v1_2.html
index f5f657d..2b572d6 100644
--- a/docs/dyn/coordinate_v1.html
+++ b/docs/dyn/prediction_v1_2.html
@@ -72,41 +72,24 @@
</style>
-<h1><a href="coordinate_v1.html">Google Maps Coordinate API</a></h1>
+<h1><a href="prediction_v1_2.html">Prediction API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="coordinate_v1.customFieldDef.html">customFieldDef()</a></code>
+ <code><a href="prediction_v1_2.hostedmodels.html">hostedmodels()</a></code>
</p>
-<p class="firstline">Returns the customFieldDef Resource.</p>
+<p class="firstline">Returns the hostedmodels Resource.</p>
<p class="toc_element">
- <code><a href="coordinate_v1.jobs.html">jobs()</a></code>
+ <code><a href="prediction_v1_2.training.html">training()</a></code>
</p>
-<p class="firstline">Returns the jobs Resource.</p>
-
-<p class="toc_element">
- <code><a href="coordinate_v1.location.html">location()</a></code>
-</p>
-<p class="firstline">Returns the location Resource.</p>
-
-<p class="toc_element">
- <code><a href="coordinate_v1.schedule.html">schedule()</a></code>
-</p>
-<p class="firstline">Returns the schedule Resource.</p>
-
-<p class="toc_element">
- <code><a href="coordinate_v1.team.html">team()</a></code>
-</p>
-<p class="firstline">Returns the team Resource.</p>
-
-<p class="toc_element">
- <code><a href="coordinate_v1.worker.html">worker()</a></code>
-</p>
-<p class="firstline">Returns the worker Resource.</p>
+<p class="firstline">Returns the training Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<p class="toc_element">
+ <code><a href="#predict">predict(data, body)</a></code></p>
+<p class="firstline">Submit data and request a prediction</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="new_batch_http_request">new_batch_http_request()</code>
@@ -125,4 +108,40 @@
</pre>
</div>
+<div class="method">
+ <code class="details" id="predict">predict(data, body)</code>
+ <pre>Submit data and request a prediction
+
+Args:
+ data: string, mybucket%2Fmydata resource in Google Storage (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "input": {
+ "csvInstance": [
+ "",
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#output",
+ "outputLabel": "A String",
+ "id": "A String",
+ "outputMulti": [
+ {
+ "score": 3.14,
+ "label": "A String",
+ },
+ ],
+ "outputValue": 3.14,
+ "selfLink": "A String",
+ }</pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/prediction_v1_2.training.html b/docs/dyn/prediction_v1_2.training.html
new file mode 100644
index 0000000..4df60dc
--- /dev/null
+++ b/docs/dyn/prediction_v1_2.training.html
@@ -0,0 +1,193 @@
+<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="prediction_v1_2.html">Prediction API</a> . <a href="prediction_v1_2.training.html">training</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(data)</a></code></p>
+<p class="firstline">Delete a trained model</p>
+<p class="toc_element">
+ <code><a href="#get">get(data)</a></code></p>
+<p class="firstline">Check training status of your model</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(body, data=None)</a></code></p>
+<p class="firstline">Begin training your model</p>
+<p class="toc_element">
+ <code><a href="#update">update(data, body)</a></code></p>
+<p class="firstline">Add new data to a trained model</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(data)</code>
+ <pre>Delete a trained model
+
+Args:
+ data: string, mybucket/mydata resource in Google Storage (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(data)</code>
+ <pre>Check training status of your model
+
+Args:
+ data: string, mybucket/mydata resource in Google Storage (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "selfLink": "A String",
+ "kind": "prediction#training",
+ "trainingStatus": "A String",
+ "id": "A String",
+ "modelInfo": {
+ "classificationAccuracy": 3.14,
+ "meanSquaredError": 3.14,
+ "modelType": "A String",
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(body, data=None)</code>
+ <pre>Begin training your model
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "selfLink": "A String",
+ "kind": "prediction#training",
+ "trainingStatus": "A String",
+ "id": "A String",
+ "modelInfo": {
+ "classificationAccuracy": 3.14,
+ "meanSquaredError": 3.14,
+ "modelType": "A String",
+ },
+ }
+
+ data: string, mybucket/mydata resource in Google Storage
+
+Returns:
+ An object of the form:
+
+ {
+ "selfLink": "A String",
+ "kind": "prediction#training",
+ "trainingStatus": "A String",
+ "id": "A String",
+ "modelInfo": {
+ "classificationAccuracy": 3.14,
+ "meanSquaredError": 3.14,
+ "modelType": "A String",
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(data, body)</code>
+ <pre>Add new data to a trained model
+
+Args:
+ data: string, mybucket/mydata resource in Google Storage (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "classLabel": "A String", # The true class label of this instance
+ "csvInstance": [ # The input features for this instance
+ "",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "selfLink": "A String",
+ "kind": "prediction#training",
+ "trainingStatus": "A String",
+ "id": "A String",
+ "modelInfo": {
+ "classificationAccuracy": 3.14,
+ "meanSquaredError": 3.14,
+ "modelType": "A String",
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/prediction_v1_3.hostedmodels.html b/docs/dyn/prediction_v1_3.hostedmodels.html
new file mode 100644
index 0000000..61cff0e
--- /dev/null
+++ b/docs/dyn/prediction_v1_3.hostedmodels.html
@@ -0,0 +1,117 @@
+<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="prediction_v1_3.html">Prediction API</a> . <a href="prediction_v1_3.hostedmodels.html">hostedmodels</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#predict">predict(hostedModelName, body)</a></code></p>
+<p class="firstline">Submit input and request an output against a hosted model</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="predict">predict(hostedModelName, body)</code>
+ <pre>Submit input and request an output against a hosted model
+
+Args:
+ hostedModelName: string, The name of a hosted model (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "input": { # Input to the model for a prediction
+ "csvInstance": [ # A list of input features, these can be strings or doubles.
+ "",
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#output", # What kind of resource this is.
+ "outputLabel": "A String", # The most likely class [Categorical models only].
+ "id": "A String", # The unique name for the predictive model.
+ "outputMulti": [ # A list of classes with their estimated probabilities [Categorical models only].
+ {
+ "score": 3.14, # The probability of the class.
+ "label": "A String", # The class label.
+ },
+ ],
+ "outputValue": 3.14, # The estimated regression value [Regression models only].
+ "selfLink": "A String", # A URL to re-request this resource.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/manager_v1beta2.html b/docs/dyn/prediction_v1_3.html
similarity index 85%
copy from docs/dyn/manager_v1beta2.html
copy to docs/dyn/prediction_v1_3.html
index 44fc028..dec41b5 100644
--- a/docs/dyn/manager_v1beta2.html
+++ b/docs/dyn/prediction_v1_3.html
@@ -72,17 +72,17 @@
</style>
-<h1><a href="manager_v1beta2.html">Deployment Manager API</a></h1>
+<h1><a href="prediction_v1_3.html">Prediction API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="manager_v1beta2.deployments.html">deployments()</a></code>
+ <code><a href="prediction_v1_3.hostedmodels.html">hostedmodels()</a></code>
</p>
-<p class="firstline">Returns the deployments Resource.</p>
+<p class="firstline">Returns the hostedmodels Resource.</p>
<p class="toc_element">
- <code><a href="manager_v1beta2.templates.html">templates()</a></code>
+ <code><a href="prediction_v1_3.training.html">training()</a></code>
</p>
-<p class="firstline">Returns the templates Resource.</p>
+<p class="firstline">Returns the training Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/prediction_v1_3.training.html b/docs/dyn/prediction_v1_3.training.html
new file mode 100644
index 0000000..38f32c2
--- /dev/null
+++ b/docs/dyn/prediction_v1_3.training.html
@@ -0,0 +1,295 @@
+<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="prediction_v1_3.html">Prediction API</a> . <a href="prediction_v1_3.training.html">training</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(data)</a></code></p>
+<p class="firstline">Delete a trained model</p>
+<p class="toc_element">
+ <code><a href="#get">get(data)</a></code></p>
+<p class="firstline">Check training status of your model</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(body)</a></code></p>
+<p class="firstline">Begin training your model</p>
+<p class="toc_element">
+ <code><a href="#predict">predict(data, body)</a></code></p>
+<p class="firstline">Submit data and request a prediction</p>
+<p class="toc_element">
+ <code><a href="#update">update(data, body)</a></code></p>
+<p class="firstline">Add new data to a trained model</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(data)</code>
+ <pre>Delete a trained model
+
+Args:
+ data: string, mybucket/mydata resource in Google Storage (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(data)</code>
+ <pre>Check training status of your model
+
+Args:
+ data: string, mybucket/mydata resource in Google Storage (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#training", # What kind of resource this is.
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+ "a_key": 3.14, # The true class associated with how many instances it had
+ },
+ "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
+ "a_key": { # The true class label.
+ "a_key": 3.14, # The pair {predicted_label, count}.
+ },
+ },
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "numberClasses": "A String", # Number of classes in the trained model [Categorical models only].
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for classes to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(body)</code>
+ <pre>Begin training your model
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "kind": "prediction#training", # What kind of resource this is.
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+ "a_key": 3.14, # The true class associated with how many instances it had
+ },
+ "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
+ "a_key": { # The true class label.
+ "a_key": 3.14, # The pair {predicted_label, count}.
+ },
+ },
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "numberClasses": "A String", # Number of classes in the trained model [Categorical models only].
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for classes to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#training", # What kind of resource this is.
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+ "a_key": 3.14, # The true class associated with how many instances it had
+ },
+ "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
+ "a_key": { # The true class label.
+ "a_key": 3.14, # The pair {predicted_label, count}.
+ },
+ },
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "numberClasses": "A String", # Number of classes in the trained model [Categorical models only].
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for classes to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="predict">predict(data, body)</code>
+ <pre>Submit data and request a prediction
+
+Args:
+ data: string, mybucket/mydata resource in Google Storage (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "input": { # Input to the model for a prediction
+ "csvInstance": [ # A list of input features, these can be strings or doubles.
+ "",
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#output", # What kind of resource this is.
+ "outputLabel": "A String", # The most likely class [Categorical models only].
+ "id": "A String", # The unique name for the predictive model.
+ "outputMulti": [ # A list of classes with their estimated probabilities [Categorical models only].
+ {
+ "score": 3.14, # The probability of the class.
+ "label": "A String", # The class label.
+ },
+ ],
+ "outputValue": 3.14, # The estimated regression value [Regression models only].
+ "selfLink": "A String", # A URL to re-request this resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(data, body)</code>
+ <pre>Add new data to a trained model
+
+Args:
+ data: string, mybucket/mydata resource in Google Storage (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "classLabel": "A String", # The true class label of this instance
+ "csvInstance": [ # The input features for this instance
+ "",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#training", # What kind of resource this is.
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+ "a_key": 3.14, # The true class associated with how many instances it had
+ },
+ "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
+ "a_key": { # The true class label.
+ "a_key": 3.14, # The pair {predicted_label, count}.
+ },
+ },
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "numberClasses": "A String", # Number of classes in the trained model [Categorical models only].
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for classes to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/prediction_v1_4.hostedmodels.html b/docs/dyn/prediction_v1_4.hostedmodels.html
new file mode 100644
index 0000000..4047258
--- /dev/null
+++ b/docs/dyn/prediction_v1_4.hostedmodels.html
@@ -0,0 +1,117 @@
+<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="prediction_v1_4.html">Prediction API</a> . <a href="prediction_v1_4.hostedmodels.html">hostedmodels</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#predict">predict(hostedModelName, body)</a></code></p>
+<p class="firstline">Submit input and request an output against a hosted model.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="predict">predict(hostedModelName, body)</code>
+ <pre>Submit input and request an output against a hosted model.
+
+Args:
+ hostedModelName: string, The name of a hosted model. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "input": { # Input to the model for a prediction
+ "csvInstance": [ # A list of input features, these can be strings or doubles.
+ "",
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#output", # What kind of resource this is.
+ "outputLabel": "A String", # The most likely class label [Categorical models only].
+ "id": "A String", # The unique name for the predictive model.
+ "outputMulti": [ # A list of class labels with their estimated probabilities [Categorical models only].
+ {
+ "score": 3.14, # The probability of the class label.
+ "label": "A String", # The class label.
+ },
+ ],
+ "outputValue": 3.14, # The estimated regression value [Regression models only].
+ "selfLink": "A String", # A URL to re-request this resource.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/manager_v1beta2.html b/docs/dyn/prediction_v1_4.html
similarity index 85%
copy from docs/dyn/manager_v1beta2.html
copy to docs/dyn/prediction_v1_4.html
index 44fc028..5588dc2 100644
--- a/docs/dyn/manager_v1beta2.html
+++ b/docs/dyn/prediction_v1_4.html
@@ -72,17 +72,17 @@
</style>
-<h1><a href="manager_v1beta2.html">Deployment Manager API</a></h1>
+<h1><a href="prediction_v1_4.html">Prediction API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="manager_v1beta2.deployments.html">deployments()</a></code>
+ <code><a href="prediction_v1_4.hostedmodels.html">hostedmodels()</a></code>
</p>
-<p class="firstline">Returns the deployments Resource.</p>
+<p class="firstline">Returns the hostedmodels Resource.</p>
<p class="toc_element">
- <code><a href="manager_v1beta2.templates.html">templates()</a></code>
+ <code><a href="prediction_v1_4.trainedmodels.html">trainedmodels()</a></code>
</p>
-<p class="firstline">Returns the templates Resource.</p>
+<p class="firstline">Returns the trainedmodels Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/prediction_v1_4.trainedmodels.html b/docs/dyn/prediction_v1_4.trainedmodels.html
new file mode 100644
index 0000000..c12261e
--- /dev/null
+++ b/docs/dyn/prediction_v1_4.trainedmodels.html
@@ -0,0 +1,328 @@
+<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="prediction_v1_4.html">Prediction API</a> . <a href="prediction_v1_4.trainedmodels.html">trainedmodels</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(id)</a></code></p>
+<p class="firstline">Delete a trained model.</p>
+<p class="toc_element">
+ <code><a href="#get">get(id)</a></code></p>
+<p class="firstline">Check training status of your model.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(body)</a></code></p>
+<p class="firstline">Begin training your model.</p>
+<p class="toc_element">
+ <code><a href="#predict">predict(id, body)</a></code></p>
+<p class="firstline">Submit model id and request a prediction</p>
+<p class="toc_element">
+ <code><a href="#update">update(id, body)</a></code></p>
+<p class="firstline">Add new data to a trained model.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(id)</code>
+ <pre>Delete a trained model.
+
+Args:
+ id: string, The unique name for the predictive model. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(id)</code>
+ <pre>Check training status of your model.
+
+Args:
+ id: string, The unique name for the predictive model. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#training", # What kind of resource this is.
+ "storageDataLocation": "A String", # Google storage location of the training data file.
+ "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
+ "dataAnalysis": { # Data Analysis.
+ "warnings": [
+ "A String",
+ ],
+ },
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+ "a_key": 3.14,
+ },
+ "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+ "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
+ "a_key": {
+ "a_key": 3.14,
+ },
+ },
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(body)</code>
+ <pre>Begin training your model.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "kind": "prediction#training", # What kind of resource this is.
+ "storageDataLocation": "A String", # Google storage location of the training data file.
+ "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
+ "dataAnalysis": { # Data Analysis.
+ "warnings": [
+ "A String",
+ ],
+ },
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+ "a_key": 3.14,
+ },
+ "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+ "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
+ "a_key": {
+ "a_key": 3.14,
+ },
+ },
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#training", # What kind of resource this is.
+ "storageDataLocation": "A String", # Google storage location of the training data file.
+ "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
+ "dataAnalysis": { # Data Analysis.
+ "warnings": [
+ "A String",
+ ],
+ },
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+ "a_key": 3.14,
+ },
+ "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+ "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
+ "a_key": {
+ "a_key": 3.14,
+ },
+ },
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="predict">predict(id, body)</code>
+ <pre>Submit model id and request a prediction
+
+Args:
+ id: string, The unique name for the predictive model. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "input": { # Input to the model for a prediction
+ "csvInstance": [ # A list of input features, these can be strings or doubles.
+ "",
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#output", # What kind of resource this is.
+ "outputLabel": "A String", # The most likely class label [Categorical models only].
+ "id": "A String", # The unique name for the predictive model.
+ "outputMulti": [ # A list of class labels with their estimated probabilities [Categorical models only].
+ {
+ "score": 3.14, # The probability of the class label.
+ "label": "A String", # The class label.
+ },
+ ],
+ "outputValue": 3.14, # The estimated regression value [Regression models only].
+ "selfLink": "A String", # A URL to re-request this resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(id, body)</code>
+ <pre>Add new data to a trained model.
+
+Args:
+ id: string, The unique name for the predictive model. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "output": "A String", # The generic output value - could be regression value or class label
+ "csvInstance": [ # The input features for this instance
+ "",
+ ],
+ "label": "A String", # The class label of this instance
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#training", # What kind of resource this is.
+ "storageDataLocation": "A String", # Google storage location of the training data file.
+ "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
+ "dataAnalysis": { # Data Analysis.
+ "warnings": [
+ "A String",
+ ],
+ },
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+ "a_key": 3.14,
+ },
+ "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+ "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
+ "a_key": {
+ "a_key": 3.14,
+ },
+ },
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/prediction_v1_5.hostedmodels.html b/docs/dyn/prediction_v1_5.hostedmodels.html
new file mode 100644
index 0000000..6fedb91
--- /dev/null
+++ b/docs/dyn/prediction_v1_5.hostedmodels.html
@@ -0,0 +1,117 @@
+<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="prediction_v1_5.html">Prediction API</a> . <a href="prediction_v1_5.hostedmodels.html">hostedmodels</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#predict">predict(hostedModelName, body)</a></code></p>
+<p class="firstline">Submit input and request an output against a hosted model.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="predict">predict(hostedModelName, body)</code>
+ <pre>Submit input and request an output against a hosted model.
+
+Args:
+ hostedModelName: string, The name of a hosted model. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "input": { # Input to the model for a prediction
+ "csvInstance": [ # A list of input features, these can be strings or doubles.
+ "",
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#output", # What kind of resource this is.
+ "outputLabel": "A String", # The most likely class label [Categorical models only].
+ "id": "A String", # The unique name for the predictive model.
+ "outputMulti": [ # A list of class labels with their estimated probabilities [Categorical models only].
+ {
+ "score": 3.14, # The probability of the class label.
+ "label": "A String", # The class label.
+ },
+ ],
+ "outputValue": 3.14, # The estimated regression value [Regression models only].
+ "selfLink": "A String", # A URL to re-request this resource.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/manager_v1beta2.html b/docs/dyn/prediction_v1_5.html
similarity index 85%
copy from docs/dyn/manager_v1beta2.html
copy to docs/dyn/prediction_v1_5.html
index 44fc028..0aa19c1 100644
--- a/docs/dyn/manager_v1beta2.html
+++ b/docs/dyn/prediction_v1_5.html
@@ -72,17 +72,17 @@
</style>
-<h1><a href="manager_v1beta2.html">Deployment Manager API</a></h1>
+<h1><a href="prediction_v1_5.html">Prediction API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="manager_v1beta2.deployments.html">deployments()</a></code>
+ <code><a href="prediction_v1_5.hostedmodels.html">hostedmodels()</a></code>
</p>
-<p class="firstline">Returns the deployments Resource.</p>
+<p class="firstline">Returns the hostedmodels Resource.</p>
<p class="toc_element">
- <code><a href="manager_v1beta2.templates.html">templates()</a></code>
+ <code><a href="prediction_v1_5.trainedmodels.html">trainedmodels()</a></code>
</p>
-<p class="firstline">Returns the templates Resource.</p>
+<p class="firstline">Returns the trainedmodels Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/prediction_v1_5.trainedmodels.html b/docs/dyn/prediction_v1_5.trainedmodels.html
new file mode 100644
index 0000000..1d4c096
--- /dev/null
+++ b/docs/dyn/prediction_v1_5.trainedmodels.html
@@ -0,0 +1,498 @@
+<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="prediction_v1_5.html">Prediction API</a> . <a href="prediction_v1_5.trainedmodels.html">trainedmodels</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#analyze">analyze(id)</a></code></p>
+<p class="firstline">Get analysis of the model and the data the model was trained on.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(id)</a></code></p>
+<p class="firstline">Delete a trained model.</p>
+<p class="toc_element">
+ <code><a href="#get">get(id)</a></code></p>
+<p class="firstline">Check training status of your model.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(body)</a></code></p>
+<p class="firstline">Begin training your model.</p>
+<p class="toc_element">
+ <code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
+<p class="firstline">List available models.</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="#predict">predict(id, body)</a></code></p>
+<p class="firstline">Submit model id and request a prediction.</p>
+<p class="toc_element">
+ <code><a href="#update">update(id, body)</a></code></p>
+<p class="firstline">Add new data to a trained model.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="analyze">analyze(id)</code>
+ <pre>Get analysis of the model and the data the model was trained on.
+
+Args:
+ id: string, The unique name for the predictive model. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#analyze", # What kind of resource this is.
+ "errors": [ # List of errors with the data.
+ {
+ "a_key": "A String", # Error level followed by a detailed error message.
+ },
+ ],
+ "dataDescription": { # Description of the data the model was trained on.
+ "outputFeature": { # Description of the output value or label.
+ "text": [ # Description of the output labels in the data set.
+ {
+ "count": "A String", # Number of times the output label occurred in the data set.
+ "value": "A String", # The output label.
+ },
+ ],
+ "numeric": { # Description of the output values in the data set.
+ "count": "A String", # Number of numeric output values in the data set.
+ "variance": 3.14, # Variance of the output values in the data set.
+ "mean": 3.14, # Mean of the output values in the data set.
+ },
+ },
+ "features": [ # Description of the input features in the data set.
+ {
+ "index": "A String", # The feature index.
+ "text": { # Description of multiple-word text values of this feature.
+ "count": "A String", # Number of multiple-word text values for this feature.
+ },
+ "numeric": { # Description of the numeric values of this feature.
+ "count": "A String", # Number of numeric values for this feature in the data set.
+ "variance": 3.14, # Variance of the numeric values of this feature in the data set.
+ "mean": 3.14, # Mean of the numeric values of this feature in the data set.
+ },
+ "categorical": { # Description of the categorical values of this feature.
+ "count": "A String", # Number of categorical values for this feature in the data.
+ "values": [ # List of all the categories for this feature in the data set.
+ {
+ "count": "A String", # Number of times this feature had this value.
+ "value": "A String", # The category name.
+ },
+ ],
+ },
+ },
+ ],
+ },
+ "modelDescription": { # Description of the model.
+ "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+ "a_key": 3.14,
+ },
+ "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
+ "a_key": {
+ "a_key": 3.14,
+ },
+ },
+ "modelinfo": { # Basic information about the model.
+ "kind": "prediction#training", # What kind of resource this is.
+ "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
+ "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
+ "storageDataLocation": "A String", # Google storage location of the training data file.
+ "modelType": "A String", # Type of predictive model (classification or regression)
+ "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+ "trainingInstances": [ # Instances to train model on.
+ {
+ "output": "A String", # The generic output value - could be regression or class label
+ "csvInstance": [ # The input features for this instance
+ "",
+ ],
+ },
+ ],
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ },
+ },
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(id)</code>
+ <pre>Delete a trained model.
+
+Args:
+ id: string, The unique name for the predictive model. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(id)</code>
+ <pre>Check training status of your model.
+
+Args:
+ id: string, The unique name for the predictive model. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#training", # What kind of resource this is.
+ "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
+ "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
+ "storageDataLocation": "A String", # Google storage location of the training data file.
+ "modelType": "A String", # Type of predictive model (classification or regression)
+ "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+ "trainingInstances": [ # Instances to train model on.
+ {
+ "output": "A String", # The generic output value - could be regression or class label
+ "csvInstance": [ # The input features for this instance
+ "",
+ ],
+ },
+ ],
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(body)</code>
+ <pre>Begin training your model.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "kind": "prediction#training", # What kind of resource this is.
+ "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
+ "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
+ "storageDataLocation": "A String", # Google storage location of the training data file.
+ "modelType": "A String", # Type of predictive model (classification or regression)
+ "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+ "trainingInstances": [ # Instances to train model on.
+ {
+ "output": "A String", # The generic output value - could be regression or class label
+ "csvInstance": [ # The input features for this instance
+ "",
+ ],
+ },
+ ],
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#training", # What kind of resource this is.
+ "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
+ "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
+ "storageDataLocation": "A String", # Google storage location of the training data file.
+ "modelType": "A String", # Type of predictive model (classification or regression)
+ "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+ "trainingInstances": [ # Instances to train model on.
+ {
+ "output": "A String", # The generic output value - could be regression or class label
+ "csvInstance": [ # The input features for this instance
+ "",
+ ],
+ },
+ ],
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(pageToken=None, maxResults=None)</code>
+ <pre>List available models.
+
+Args:
+ pageToken: string, Pagination token
+ maxResults: integer, Maximum number of results to return
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
+ "items": [ # List of models.
+ {
+ "kind": "prediction#training", # What kind of resource this is.
+ "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
+ "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
+ "storageDataLocation": "A String", # Google storage location of the training data file.
+ "modelType": "A String", # Type of predictive model (classification or regression)
+ "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+ "trainingInstances": [ # Instances to train model on.
+ {
+ "output": "A String", # The generic output value - could be regression or class label
+ "csvInstance": [ # The input features for this instance
+ "",
+ ],
+ },
+ ],
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ },
+ ],
+ "kind": "prediction#list", # What kind of resource this is.
+ "selfLink": "A String", # A URL to re-request this resource.
+ }</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="predict">predict(id, body)</code>
+ <pre>Submit model id and request a prediction.
+
+Args:
+ id: string, The unique name for the predictive model. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "input": { # Input to the model for a prediction
+ "csvInstance": [ # A list of input features, these can be strings or doubles.
+ "",
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#output", # What kind of resource this is.
+ "outputLabel": "A String", # The most likely class label [Categorical models only].
+ "id": "A String", # The unique name for the predictive model.
+ "outputMulti": [ # A list of class labels with their estimated probabilities [Categorical models only].
+ {
+ "score": 3.14, # The probability of the class label.
+ "label": "A String", # The class label.
+ },
+ ],
+ "outputValue": 3.14, # The estimated regression value [Regression models only].
+ "selfLink": "A String", # A URL to re-request this resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(id, body)</code>
+ <pre>Add new data to a trained model.
+
+Args:
+ id: string, The unique name for the predictive model. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "output": "A String", # The generic output value - could be regression value or class label
+ "csvInstance": [ # The input features for this instance
+ "",
+ ],
+ "label": "A String", # The class label of this instance
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "prediction#training", # What kind of resource this is.
+ "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
+ "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
+ "storageDataLocation": "A String", # Google storage location of the training data file.
+ "modelType": "A String", # Type of predictive model (classification or regression)
+ "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
+ "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+ "modelInfo": { # Model metadata.
+ "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+ "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+ "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+ "numberInstances": "A String", # Number of valid data instances used in the trained model.
+ "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+ "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+ },
+ "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+ "trainingInstances": [ # Instances to train model on.
+ {
+ "output": "A String", # The generic output value - could be regression or class label
+ "csvInstance": [ # The input features for this instance
+ "",
+ ],
+ },
+ ],
+ "id": "A String", # The unique name for the predictive model.
+ "selfLink": "A String", # A URL to re-request this resource.
+ "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+ { # Class label (string).
+ "a_key": 3.14,
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/pubsub_v1beta1.html b/docs/dyn/pubsub_v1beta1a.html
similarity index 90%
rename from docs/dyn/pubsub_v1beta1.html
rename to docs/dyn/pubsub_v1beta1a.html
index f0a882d..10e9da3 100644
--- a/docs/dyn/pubsub_v1beta1.html
+++ b/docs/dyn/pubsub_v1beta1a.html
@@ -72,15 +72,15 @@
</style>
-<h1><a href="pubsub_v1beta1.html">Google Cloud Pub/Sub API</a></h1>
+<h1><a href="pubsub_v1beta1a.html">Google Cloud Pub/Sub API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="pubsub_v1beta1.subscriptions.html">subscriptions()</a></code>
+ <code><a href="pubsub_v1beta1a.subscriptions.html">subscriptions()</a></code>
</p>
<p class="firstline">Returns the subscriptions Resource.</p>
<p class="toc_element">
- <code><a href="pubsub_v1beta1.topics.html">topics()</a></code>
+ <code><a href="pubsub_v1beta1a.topics.html">topics()</a></code>
</p>
<p class="firstline">Returns the topics Resource.</p>
diff --git a/docs/dyn/pubsub_v1beta1.subscriptions.html b/docs/dyn/pubsub_v1beta1a.subscriptions.html
similarity index 71%
rename from docs/dyn/pubsub_v1beta1.subscriptions.html
rename to docs/dyn/pubsub_v1beta1a.subscriptions.html
index 0a0a56f..cdd1712 100644
--- a/docs/dyn/pubsub_v1beta1.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta1a.subscriptions.html
@@ -72,41 +72,41 @@
</style>
-<h1><a href="pubsub_v1beta1.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1beta1.subscriptions.html">subscriptions</a></h1>
+<h1><a href="pubsub_v1beta1a.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1beta1a.subscriptions.html">subscriptions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#acknowledge">acknowledge(body)</a></code></p>
+ <code><a href="#acknowledge">acknowledge(body, x__xgafv=None)</a></code></p>
<p class="firstline">Acknowledges a particular received message: the Pub/Sub system can remove the given message from the subscription. Acknowledging a message whose Ack deadline has expired may succeed, but the message could have been already redelivered. Acknowledging a message more than once will not result in an error. This is only used for messages received via pull.</p>
<p class="toc_element">
- <code><a href="#create">create(body)</a></code></p>
-<p class="firstline">Creates a subscription on a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND.</p>
+ <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a subscription on a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.</p>
<p class="toc_element">
- <code><a href="#delete">delete(subscription)</a></code></p>
+ <code><a href="#delete">delete(subscription, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND.</p>
<p class="toc_element">
- <code><a href="#get">get(subscription)</a></code></p>
+ <code><a href="#get">get(subscription, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the configuration details of a subscription.</p>
<p class="toc_element">
- <code><a href="#list">list(pageToken=None, maxResults=None, query=None)</a></code></p>
+ <code><a href="#list">list(maxResults=None, pageToken=None, query=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists matching subscriptions.</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="#modifyAckDeadline">modifyAckDeadline(body)</a></code></p>
+ <code><a href="#modifyAckDeadline">modifyAckDeadline(body, x__xgafv=None)</a></code></p>
<p class="firstline">Modifies the Ack deadline for a message received from a pull request.</p>
<p class="toc_element">
- <code><a href="#modifyPushConfig">modifyPushConfig(body)</a></code></p>
+ <code><a href="#modifyPushConfig">modifyPushConfig(body, x__xgafv=None)</a></code></p>
<p class="firstline">Modifies the PushConfig for a specified subscription. This method can be used to suspend the flow of messages to an endpoint by clearing the PushConfig field in the request. Messages will be accumulated for delivery even if no push configuration is defined or while the configuration is modified.</p>
<p class="toc_element">
- <code><a href="#pull">pull(body)</a></code></p>
+ <code><a href="#pull">pull(body, x__xgafv=None)</a></code></p>
<p class="firstline">Pulls a single message from the server. If return_immediately is true, and no messages are available in the subscription, this method returns FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no messages are available in a reasonable amount of time (to reduce system load).</p>
<p class="toc_element">
- <code><a href="#pullBatch">pullBatch(body)</a></code></p>
+ <code><a href="#pullBatch">pullBatch(body, x__xgafv=None)</a></code></p>
<p class="firstline">Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The system is free to return UNAVAILABLE if there are too many pull requests outstanding for the given subscription.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="acknowledge">acknowledge(body)</code>
+ <code class="details" id="acknowledge">acknowledge(body, x__xgafv=None)</code>
<pre>Acknowledges a particular received message: the Pub/Sub system can remove the given message from the subscription. Acknowledging a message whose Ack deadline has expired may succeed, but the message could have been already redelivered. Acknowledging a message more than once will not result in an error. This is only used for messages received via pull.
Args:
@@ -120,43 +120,40 @@
"subscription": "A String", # The subscription whose message is being acknowledged.
}
-</pre>
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
+ }</pre>
</div>
<div class="method">
- <code class="details" id="create">create(body)</code>
- <pre>Creates a subscription on a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND.
-
-If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.
+ <code class="details" id="create">create(body, x__xgafv=None)</code>
+ <pre>Creates a subscription on a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed.
- #
- # For push delivery, this value is used to set the request timeout for the call to the push endpoint.
- #
- # For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).
"topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).
"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it.
"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
},
"name": "A String", # Name of the subscription.
}
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed.
- #
- # For push delivery, this value is used to set the request timeout for the call to the push endpoint.
- #
- # For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).
"topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).
"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it.
"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
},
@@ -165,31 +162,34 @@
</div>
<div class="method">
- <code class="details" id="delete">delete(subscription)</code>
+ <code class="details" id="delete">delete(subscription, x__xgafv=None)</code>
<pre>Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND.
Args:
subscription: string, The subscription to delete. (required)
-</pre>
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
+ }</pre>
</div>
<div class="method">
- <code class="details" id="get">get(subscription)</code>
+ <code class="details" id="get">get(subscription, x__xgafv=None)</code>
<pre>Gets the configuration details of a subscription.
Args:
subscription: string, The name of the subscription to get. (required)
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed.
- #
- # For push delivery, this value is used to set the request timeout for the call to the push endpoint.
- #
- # For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).
"topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).
"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it.
"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
},
@@ -198,13 +198,14 @@
</div>
<div class="method">
- <code class="details" id="list">list(pageToken=None, maxResults=None, query=None)</code>
+ <code class="details" id="list">list(maxResults=None, pageToken=None, query=None, x__xgafv=None)</code>
<pre>Lists matching subscriptions.
Args:
- pageToken: string, The value obtained in the last ListSubscriptionsResponse for continuation.
maxResults: integer, Maximum number of subscriptions to return.
+ pageToken: string, The value obtained in the last ListSubscriptionsResponse for continuation.
query: string, A valid label query expression.
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
@@ -213,12 +214,8 @@
"nextPageToken": "A String", # If not empty, indicates that there are more subscriptions that match the request and this value should be passed to the next ListSubscriptionsRequest to continue.
"subscription": [ # The subscriptions that match the request.
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed.
- #
- # For push delivery, this value is used to set the request timeout for the call to the push endpoint.
- #
- # For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).
"topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).
"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it.
"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
},
@@ -243,7 +240,7 @@
</div>
<div class="method">
- <code class="details" id="modifyAckDeadline">modifyAckDeadline(body)</code>
+ <code class="details" id="modifyAckDeadline">modifyAckDeadline(body, x__xgafv=None)</code>
<pre>Modifies the Ack deadline for a message received from a pull request.
Args:
@@ -253,17 +250,23 @@
{ # Request for the ModifyAckDeadline method.
"ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero may immediately make the message available for another pull request.
"ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated, not both.
- "subscription": "A String", # Next Index: 5 The name of the subscription from which messages are being pulled.
"ackIds": [ # List of acknowledgment IDs. Either this field or ack_id should be populated, not both.
"A String",
],
+ "subscription": "A String", # Next Index: 5 The name of the subscription from which messages are being pulled.
}
-</pre>
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
+ }</pre>
</div>
<div class="method">
- <code class="details" id="modifyPushConfig">modifyPushConfig(body)</code>
+ <code class="details" id="modifyPushConfig">modifyPushConfig(body, x__xgafv=None)</code>
<pre>Modifies the PushConfig for a specified subscription. This method can be used to suspend the flow of messages to an endpoint by clearing the PushConfig field in the request. Messages will be accumulated for delivery even if no push configuration is defined or while the configuration is modified.
Args:
@@ -277,11 +280,17 @@
"subscription": "A String", # The name of the subscription.
}
-</pre>
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
+ }</pre>
</div>
<div class="method">
- <code class="details" id="pull">pull(body)</code>
+ <code class="details" id="pull">pull(body, x__xgafv=None)</code>
<pre>Pulls a single message from the server. If return_immediately is true, and no messages are available in the subscription, this method returns FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no messages are available in a reasonable amount of time (to reduce system load).
Args:
@@ -293,6 +302,7 @@
"subscription": "A String", # The subscription from which a message should be pulled.
}
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
@@ -303,19 +313,12 @@
"message": { # A message data and its labels. # A received message.
"messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
"data": "A String", # The message payload.
+ "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch.
"label": [ # Optional list of labels for this message. Keys in this collection must be unique.
{ # A key-value pair applied to a given object.
"numValue": "A String", # An integer value.
"strValue": "A String", # A string value.
- "key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated.
- #
- # Keys are defined by the following grammar:
- #
- # key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ]
- #
- # where "hostname" and "alphadigit" are defined as in RFC 1738.
- #
- # Example key: spanner.google.com/universe
+ "key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated. Keys are defined by the following grammar: key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe
},
],
},
@@ -327,7 +330,7 @@
</div>
<div class="method">
- <code class="details" id="pullBatch">pullBatch(body)</code>
+ <code class="details" id="pullBatch">pullBatch(body, x__xgafv=None)</code>
<pre>Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The system is free to return UNAVAILABLE if there are too many pull requests outstanding for the given subscription.
Args:
@@ -340,6 +343,7 @@
"subscription": "A String", # The subscription from which messages should be pulled.
}
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
@@ -352,19 +356,12 @@
"message": { # A message data and its labels. # A received message.
"messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
"data": "A String", # The message payload.
+ "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch.
"label": [ # Optional list of labels for this message. Keys in this collection must be unique.
{ # A key-value pair applied to a given object.
"numValue": "A String", # An integer value.
"strValue": "A String", # A string value.
- "key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated.
- #
- # Keys are defined by the following grammar:
- #
- # key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ]
- #
- # where "hostname" and "alphadigit" are defined as in RFC 1738.
- #
- # Example key: spanner.google.com/universe
+ "key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated. Keys are defined by the following grammar: key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe
},
],
},
diff --git a/docs/dyn/pubsub_v1beta1.topics.html b/docs/dyn/pubsub_v1beta1a.topics.html
similarity index 69%
rename from docs/dyn/pubsub_v1beta1.topics.html
rename to docs/dyn/pubsub_v1beta1a.topics.html
index 9dbfbfc..17132a6 100644
--- a/docs/dyn/pubsub_v1beta1.topics.html
+++ b/docs/dyn/pubsub_v1beta1a.topics.html
@@ -72,32 +72,32 @@
</style>
-<h1><a href="pubsub_v1beta1.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1beta1.topics.html">topics</a></h1>
+<h1><a href="pubsub_v1beta1a.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1beta1a.topics.html">topics</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(body)</a></code></p>
+ <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates the given topic with the given name.</p>
<p class="toc_element">
- <code><a href="#delete">delete(topic)</a></code></p>
+ <code><a href="#delete">delete(topic, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name.</p>
<p class="toc_element">
- <code><a href="#get">get(topic)</a></code></p>
+ <code><a href="#get">get(topic, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here.</p>
<p class="toc_element">
- <code><a href="#list">list(pageToken=None, maxResults=None, query=None)</a></code></p>
+ <code><a href="#list">list(maxResults=None, pageToken=None, query=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists matching topics.</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="#publish">publish(body)</a></code></p>
+ <code><a href="#publish">publish(body, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.</p>
<p class="toc_element">
- <code><a href="#publishBatch">publishBatch(body)</a></code></p>
+ <code><a href="#publishBatch">publishBatch(body, x__xgafv=None)</a></code></p>
<p class="firstline">Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(body)</code>
+ <code class="details" id="create">create(body, x__xgafv=None)</code>
<pre>Creates the given topic with the given name.
Args:
@@ -108,6 +108,7 @@
"name": "A String", # Name of the topic.
}
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
@@ -118,20 +119,27 @@
</div>
<div class="method">
- <code class="details" id="delete">delete(topic)</code>
+ <code class="details" id="delete">delete(topic, x__xgafv=None)</code>
<pre>Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name.
Args:
topic: string, Name of the topic to delete. (required)
-</pre>
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
+ }</pre>
</div>
<div class="method">
- <code class="details" id="get">get(topic)</code>
+ <code class="details" id="get">get(topic, x__xgafv=None)</code>
<pre>Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here.
Args:
topic: string, The name of the topic to get. (required)
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
@@ -142,24 +150,25 @@
</div>
<div class="method">
- <code class="details" id="list">list(pageToken=None, maxResults=None, query=None)</code>
+ <code class="details" id="list">list(maxResults=None, pageToken=None, query=None, x__xgafv=None)</code>
<pre>Lists matching topics.
Args:
- pageToken: string, The value obtained in the last ListTopicsResponse for continuation.
maxResults: integer, Maximum number of topics to return.
+ pageToken: string, The value obtained in the last ListTopicsResponse for continuation.
query: string, A valid label query expression.
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # Response for the ListTopics method.
- "nextPageToken": "A String", # If not empty, indicates that there are more topics that match the request, and this value should be passed to the next ListTopicsRequest to continue.
"topic": [ # The resulting topics.
{ # A topic resource.
"name": "A String", # Name of the topic.
},
],
+ "nextPageToken": "A String", # If not empty, indicates that there are more topics that match the request, and this value should be passed to the next ListTopicsRequest to continue.
}</pre>
</div>
@@ -178,7 +187,7 @@
</div>
<div class="method">
- <code class="details" id="publish">publish(body)</code>
+ <code class="details" id="publish">publish(body, x__xgafv=None)</code>
<pre>Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.
Args:
@@ -190,29 +199,28 @@
"message": { # A message data and its labels. # The message to publish.
"messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
"data": "A String", # The message payload.
+ "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch.
"label": [ # Optional list of labels for this message. Keys in this collection must be unique.
{ # A key-value pair applied to a given object.
"numValue": "A String", # An integer value.
"strValue": "A String", # A string value.
- "key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated.
- #
- # Keys are defined by the following grammar:
- #
- # key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ]
- #
- # where "hostname" and "alphadigit" are defined as in RFC 1738.
- #
- # Example key: spanner.google.com/universe
+ "key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated. Keys are defined by the following grammar: key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe
},
],
},
}
-</pre>
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
+ }</pre>
</div>
<div class="method">
- <code class="details" id="publishBatch">publishBatch(body)</code>
+ <code class="details" id="publishBatch">publishBatch(body, x__xgafv=None)</code>
<pre>Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.
Args:
@@ -225,25 +233,19 @@
{ # A message data and its labels.
"messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
"data": "A String", # The message payload.
+ "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch.
"label": [ # Optional list of labels for this message. Keys in this collection must be unique.
{ # A key-value pair applied to a given object.
"numValue": "A String", # An integer value.
"strValue": "A String", # A string value.
- "key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated.
- #
- # Keys are defined by the following grammar:
- #
- # key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ]
- #
- # where "hostname" and "alphadigit" are defined as in RFC 1738.
- #
- # Example key: spanner.google.com/universe
+ "key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated. Keys are defined by the following grammar: key = hostname "/" kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe
},
],
},
],
}
+ x__xgafv: string, V1 error format.
Returns:
An object of the form:
diff --git a/docs/dyn/pubsub_v1beta2.projects.subscriptions.html b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
index bdbcd55..84a4678 100644
--- a/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
@@ -76,19 +76,19 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#acknowledge">acknowledge(subscription, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Acknowledges the messages associated with the ack tokens in the AcknowledgeRequest. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.</p>
+<p class="firstline">Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.</p>
<p class="toc_element">
<code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a subscription to a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.</p>
+<p class="firstline">Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name.</p>
<p class="toc_element">
<code><a href="#delete">delete(subscription, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.</p>
+<p class="firstline">Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.</p>
<p class="toc_element">
<code><a href="#get">get(subscription, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the configuration details of a subscription.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
+<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
<p class="toc_element">
<code><a href="#list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists matching subscriptions.</p>
@@ -97,13 +97,13 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#modifyAckDeadline">modifyAckDeadline(subscription, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.</p>
+<p class="firstline">Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.</p>
<p class="toc_element">
<code><a href="#modifyPushConfig">modifyPushConfig(subscription, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Modifies the PushConfig for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty PushConfig) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the PushConfig.</p>
+<p class="firstline">Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.</p>
<p class="toc_element">
<code><a href="#pull">pull(subscription, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return UNAVAILABLE if there are too many concurrent pull requests pending for the given subscription.</p>
+<p class="firstline">Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
@@ -113,7 +113,7 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="acknowledge">acknowledge(subscription, body, x__xgafv=None)</code>
- <pre>Acknowledges the messages associated with the ack tokens in the AcknowledgeRequest. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.
+ <pre>Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.
Args:
subscription: string, The subscription whose message is being acknowledged. (required)
@@ -121,7 +121,7 @@
The object takes the form of:
{ # Request for the Acknowledge method.
- "ackIds": [ # The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the Pull response. Must not be empty.
+ "ackIds": [ # The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty.
"A String",
],
}
@@ -131,29 +131,29 @@
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="create">create(name, body, x__xgafv=None)</code>
- <pre>Creates a subscription to a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.
+ <pre>Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name.
Args:
- name: string, The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}" for Google Cloud Pub/Sub API v1beta2. {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog". (required)
+ name: string, The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A subscription resource.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages. This will be present if and only if the subscription has not been detached from its topic.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull delivery this value is used as the initial value for the ack deadline. It may be overridden for each message using its corresponding ack_id by calling ModifyAckDeadline. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 60 seconds is used.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.
- "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
+ "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
"a_key": "A String",
},
"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
},
- "name": "A String", # The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}" for Google Cloud Pub/Sub API v1beta2. {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
+ "name": "A String", # The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
}
x__xgafv: string, V1 error format.
@@ -162,21 +162,21 @@
An object of the form:
{ # A subscription resource.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages. This will be present if and only if the subscription has not been detached from its topic.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull delivery this value is used as the initial value for the ack deadline. It may be overridden for each message using its corresponding ack_id by calling ModifyAckDeadline. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 60 seconds is used.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.
- "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
+ "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
"a_key": "A String",
},
"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
},
- "name": "A String", # The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}" for Google Cloud Pub/Sub API v1beta2. {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
+ "name": "A String", # The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(subscription, x__xgafv=None)</code>
- <pre>Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.
+ <pre>Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.
Args:
subscription: string, The subscription to delete. (required)
@@ -185,7 +185,7 @@
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
@@ -201,79 +201,40 @@
An object of the form:
{ # A subscription resource.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages. This will be present if and only if the subscription has not been detached from its topic.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull delivery this value is used as the initial value for the ack deadline. It may be overridden for each message using its corresponding ack_id by calling ModifyAckDeadline. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 60 seconds is used.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.
- "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
+ "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
"a_key": "A String",
},
"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
},
- "name": "A String", # The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}" for Google Cloud Pub/Sub API v1beta2. {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
+ "name": "A String", # The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
- <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
+ <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Args:
- resource: string, REQUIRED: The resource for which policy is being requested. Usually some path like projects/{project}. (required)
+ resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
- { # # Overview The `Policy` defines an access control policy language. It can be used to define policies that can be attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members can include user accounts, user groups, user domains, and service accounts. A role is a named set of permissions, defined by the IAM system. The definition of a role is outside the policy. A permission check involves determining the roles that include the specified permission, and then determining if the principal specified by the check is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group::admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ```
- "rules": [
- { # A rule to be applied in a Policy.
- "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The formation for in and not_in entries is the same as members in a Binding above.
- "A String",
- ],
- "description": "A String", # Human-readable description of the rule.
- "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
- "A String",
- ],
- "action": "A String", # Required
- "conditions": [ # Additional restrictions that must be met
- { # A condition to be met.
- "iam": "A String", # Trusted attributes supplied by the IAM system.
- "svc": "A String", # Trusted attributes discharged by the service.
- "value": "A String", # The object of the condition. Exactly one of these must be set.
- "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
- "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
- "A String",
- ],
- "op": "A String", # An operator to apply the subject with.
- },
- ],
- "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
- { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
- "counter": { # Options for counters # Counter options.
- "field": "A String", # The field value to attribute.
- "metric": "A String", # The metric to update.
- },
- "dataAccess": { # Write a Data Access (Gin) log # Data access options.
- },
- "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
- },
- },
- ],
- "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
},
],
- "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
- { # Associates members of various types with roles. See below for details of the various objects that can be included as members.
- "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
- "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
- "A String",
- ],
- },
- ],
- "version": 42, # The policy language version. The version of the policy itself is represented by the etag. The current version is 0.
- "etag": "A String", # Can be used to perform a read-modify-write.
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
}</pre>
</div>
@@ -284,25 +245,25 @@
Args:
project: string, The name of the cloud project that subscriptions belong to. (required)
pageSize: integer, Maximum number of subscriptions to return.
- pageToken: string, The value returned by the last ListSubscriptionsResponse; indicates that this is a continuation of a prior ListSubscriptions call, and that the system should return the next page of data.
+ pageToken: string, The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data.
x__xgafv: string, V1 error format.
Returns:
An object of the form:
- { # Response for the ListSubscriptions method.
- "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new ListSubscriptionsRequest to get more subscriptions.
+ { # Response for the `ListSubscriptions` method.
+ "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions.
"subscriptions": [ # The subscriptions that match the request.
{ # A subscription resource.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages. This will be present if and only if the subscription has not been detached from its topic.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull delivery this value is used as the initial value for the ack deadline. It may be overridden for each message using its corresponding ack_id by calling ModifyAckDeadline. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 60 seconds is used.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.
- "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
+ "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
"a_key": "A String",
},
"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
},
- "name": "A String", # The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}" for Google Cloud Pub/Sub API v1beta2. {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
+ "name": "A String", # The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
},
],
}</pre>
@@ -324,7 +285,7 @@
<div class="method">
<code class="details" id="modifyAckDeadline">modifyAckDeadline(subscription, body, x__xgafv=None)</code>
- <pre>Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.
+ <pre>Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.
Args:
subscription: string, The name of the subscription. (required)
@@ -332,8 +293,8 @@
The object takes the form of:
{ # Request for the ModifyAckDeadline method.
- "ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero may immediately make the message available for another pull request.
- "ackId": "A String", # The acknowledgment ID.
+ "ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero may immediately make the message available for another pull request.
+ "ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated, but not both.
"ackIds": [ # List of acknowledgment IDs.
"A String",
],
@@ -344,13 +305,13 @@
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="modifyPushConfig">modifyPushConfig(subscription, body, x__xgafv=None)</code>
- <pre>Modifies the PushConfig for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty PushConfig) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the PushConfig.
+ <pre>Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.
Args:
subscription: string, The name of the subscription. (required)
@@ -358,8 +319,8 @@
The object takes the form of:
{ # Request for the ModifyPushConfig method.
- "pushConfig": { # Configuration for a push delivery endpoint. # The push configuration for future deliveries. An empty pushConfig indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if Pull is not called.
- "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
+ "pushConfig": { # Configuration for a push delivery endpoint. # The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` is not called.
+ "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
"a_key": "A String",
},
"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
@@ -371,21 +332,21 @@
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="pull">pull(subscription, body, x__xgafv=None)</code>
- <pre>Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return UNAVAILABLE if there are too many concurrent pull requests pending for the given subscription.
+ <pre>Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.
Args:
subscription: string, The subscription from which messages should be pulled. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Request for the Pull method.
- "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response.
+{ # Request for the `Pull` method.
+ "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response.
"maxMessages": 42, # The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.
}
@@ -394,16 +355,17 @@
Returns:
An object of the form:
- { # Response for the Pull method.
- "receivedMessages": [ # Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than the maxMessages requested even if there are more messages available in the backlog.
+ { # Response for the `Pull` method.
+ "receivedMessages": [ # Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog.
{ # A message and its corresponding acknowledgment ID.
"ackId": "A String", # This ID can be used to acknowledge the received message.
- "message": { # A message data and its attributes. # The message.
+ "message": { # A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute. # The message.
"attributes": { # Optional attributes for this message.
"a_key": "A String",
},
- "data": "A String", # The message payload. For JSON requests, the value of this field must be base64-encoded.
- "messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
+ "data": "A String", # The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648).
+ "publishTime": "A String", # The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
+ "messageId": "A String", # ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
},
},
],
@@ -415,61 +377,22 @@
<pre>Sets the access control policy on the specified resource. Replaces any existing policy.
Args:
- resource: string, REQUIRED: The resource for which policy is being specified. Usually some path like projects/{project}/zones/{zone}/disks/{disk}. (required)
+ resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # # Overview The `Policy` defines an access control policy language. It can be used to define policies that can be attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members can include user accounts, user groups, user domains, and service accounts. A role is a named set of permissions, defined by the IAM system. The definition of a role is outside the policy. A permission check involves determining the roles that include the specified permission, and then determining if the principal specified by the check is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group::admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ``` # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
- "rules": [
- { # A rule to be applied in a Policy.
- "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The formation for in and not_in entries is the same as members in a Binding above.
- "A String",
- ],
- "description": "A String", # Human-readable description of the rule.
- "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
- "A String",
- ],
- "action": "A String", # Required
- "conditions": [ # Additional restrictions that must be met
- { # A condition to be met.
- "iam": "A String", # Trusted attributes supplied by the IAM system.
- "svc": "A String", # Trusted attributes discharged by the service.
- "value": "A String", # The object of the condition. Exactly one of these must be set.
- "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
- "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
- "A String",
- ],
- "op": "A String", # An operator to apply the subject with.
- },
- ],
- "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
- { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
- "counter": { # Options for counters # Counter options.
- "field": "A String", # The field value to attribute.
- "metric": "A String", # The metric to update.
- },
- "dataAccess": { # Write a Data Access (Gin) log # Data access options.
- },
- "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
- },
- },
- ],
- "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
},
],
- "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
- { # Associates members of various types with roles. See below for details of the various objects that can be included as members.
- "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
- "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
- "A String",
- ],
- },
- ],
- "version": 42, # The policy language version. The version of the policy itself is represented by the etag. The current version is 0.
- "etag": "A String", # Can be used to perform a read-modify-write.
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
},
}
@@ -478,56 +401,17 @@
Returns:
An object of the form:
- { # # Overview The `Policy` defines an access control policy language. It can be used to define policies that can be attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members can include user accounts, user groups, user domains, and service accounts. A role is a named set of permissions, defined by the IAM system. The definition of a role is outside the policy. A permission check involves determining the roles that include the specified permission, and then determining if the principal specified by the check is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group::admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ```
- "rules": [
- { # A rule to be applied in a Policy.
- "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The formation for in and not_in entries is the same as members in a Binding above.
- "A String",
- ],
- "description": "A String", # Human-readable description of the rule.
- "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
- "A String",
- ],
- "action": "A String", # Required
- "conditions": [ # Additional restrictions that must be met
- { # A condition to be met.
- "iam": "A String", # Trusted attributes supplied by the IAM system.
- "svc": "A String", # Trusted attributes discharged by the service.
- "value": "A String", # The object of the condition. Exactly one of these must be set.
- "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
- "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
- "A String",
- ],
- "op": "A String", # An operator to apply the subject with.
- },
- ],
- "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
- { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
- "counter": { # Options for counters # Counter options.
- "field": "A String", # The field value to attribute.
- "metric": "A String", # The metric to update.
- },
- "dataAccess": { # Write a Data Access (Gin) log # Data access options.
- },
- "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
- },
- },
- ],
- "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
},
],
- "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
- { # Associates members of various types with roles. See below for details of the various objects that can be included as members.
- "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
- "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
- "A String",
- ],
- },
- ],
- "version": 42, # The policy language version. The version of the policy itself is represented by the etag. The current version is 0.
- "etag": "A String", # Can be used to perform a read-modify-write.
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
}</pre>
</div>
@@ -536,12 +420,12 @@
<pre>Returns permissions that a caller has on the specified resource.
Args:
- resource: string, REQUIRED: The resource for which policy detail is being requested. Usually some path like projects/{project}. (required)
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
diff --git a/docs/dyn/pubsub_v1beta2.projects.topics.html b/docs/dyn/pubsub_v1beta2.projects.topics.html
index f6d3b5b..ace8c6b 100644
--- a/docs/dyn/pubsub_v1beta2.projects.topics.html
+++ b/docs/dyn/pubsub_v1beta2.projects.topics.html
@@ -84,13 +84,13 @@
<p class="firstline">Creates the given topic with the given name.</p>
<p class="toc_element">
<code><a href="#delete">delete(topic, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted.</p>
+<p class="firstline">Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.</p>
<p class="toc_element">
<code><a href="#get">get(topic, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the configuration of a topic.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
+<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
<p class="toc_element">
<code><a href="#list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists matching topics.</p>
@@ -99,7 +99,7 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#publish">publish(topic, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.</p>
+<p class="firstline">Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
@@ -112,12 +112,12 @@
<pre>Creates the given topic with the given name.
Args:
- name: string, The name of the topic. It must have the format "projects/{project}/topics/{topic}" for Google Cloud Pub/Sub API v1beta2. {topic} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog". (required)
+ name: string, The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A topic resource.
- "name": "A String", # The name of the topic. It must have the format "projects/{project}/topics/{topic}" for Google Cloud Pub/Sub API v1beta2. {topic} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
+ "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
}
x__xgafv: string, V1 error format.
@@ -126,13 +126,13 @@
An object of the form:
{ # A topic resource.
- "name": "A String", # The name of the topic. It must have the format "projects/{project}/topics/{topic}" for Google Cloud Pub/Sub API v1beta2. {topic} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
+ "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(topic, x__xgafv=None)</code>
- <pre>Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted.
+ <pre>Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.
Args:
topic: string, Name of the topic to delete. (required)
@@ -141,7 +141,7 @@
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
@@ -157,71 +157,32 @@
An object of the form:
{ # A topic resource.
- "name": "A String", # The name of the topic. It must have the format "projects/{project}/topics/{topic}" for Google Cloud Pub/Sub API v1beta2. {topic} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
+ "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
- <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
+ <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Args:
- resource: string, REQUIRED: The resource for which policy is being requested. Usually some path like projects/{project}. (required)
+ resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
- { # # Overview The `Policy` defines an access control policy language. It can be used to define policies that can be attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members can include user accounts, user groups, user domains, and service accounts. A role is a named set of permissions, defined by the IAM system. The definition of a role is outside the policy. A permission check involves determining the roles that include the specified permission, and then determining if the principal specified by the check is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group::admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ```
- "rules": [
- { # A rule to be applied in a Policy.
- "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The formation for in and not_in entries is the same as members in a Binding above.
- "A String",
- ],
- "description": "A String", # Human-readable description of the rule.
- "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
- "A String",
- ],
- "action": "A String", # Required
- "conditions": [ # Additional restrictions that must be met
- { # A condition to be met.
- "iam": "A String", # Trusted attributes supplied by the IAM system.
- "svc": "A String", # Trusted attributes discharged by the service.
- "value": "A String", # The object of the condition. Exactly one of these must be set.
- "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
- "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
- "A String",
- ],
- "op": "A String", # An operator to apply the subject with.
- },
- ],
- "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
- { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
- "counter": { # Options for counters # Counter options.
- "field": "A String", # The field value to attribute.
- "metric": "A String", # The metric to update.
- },
- "dataAccess": { # Write a Data Access (Gin) log # Data access options.
- },
- "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
- },
- },
- ],
- "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
},
],
- "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
- { # Associates members of various types with roles. See below for details of the various objects that can be included as members.
- "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
- "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
- "A String",
- ],
- },
- ],
- "version": 42, # The policy language version. The version of the policy itself is represented by the etag. The current version is 0.
- "etag": "A String", # Can be used to perform a read-modify-write.
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
}</pre>
</div>
@@ -232,17 +193,17 @@
Args:
project: string, The name of the cloud project that topics belong to. (required)
pageSize: integer, Maximum number of topics to return.
- pageToken: string, The value returned by the last ListTopicsResponse; indicates that this is a continuation of a prior ListTopics call, and that the system should return the next page of data.
+ pageToken: string, The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.
x__xgafv: string, V1 error format.
Returns:
An object of the form:
- { # Response for the ListTopics method.
- "nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the request; this value should be passed in a new ListTopicsRequest.
+ { # Response for the `ListTopics` method.
+ "nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`.
"topics": [ # The resulting topics.
{ # A topic resource.
- "name": "A String", # The name of the topic. It must have the format "projects/{project}/topics/{topic}" for Google Cloud Pub/Sub API v1beta2. {topic} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9], dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
+ "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
},
],
}</pre>
@@ -264,7 +225,7 @@
<div class="method">
<code class="details" id="publish">publish(topic, body, x__xgafv=None)</code>
- <pre>Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.
+ <pre>Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
Args:
topic: string, The messages in the request will be published on this topic. (required)
@@ -273,12 +234,13 @@
{ # Request for the Publish method.
"messages": [ # The messages to publish.
- { # A message data and its attributes.
+ { # A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
"attributes": { # Optional attributes for this message.
"a_key": "A String",
},
- "data": "A String", # The message payload. For JSON requests, the value of this field must be base64-encoded.
- "messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
+ "data": "A String", # The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648).
+ "publishTime": "A String", # The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
+ "messageId": "A String", # ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
},
],
}
@@ -288,7 +250,7 @@
Returns:
An object of the form:
- { # Response for the Publish method.
+ { # Response for the `Publish` method.
"messageIds": [ # The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
"A String",
],
@@ -300,61 +262,22 @@
<pre>Sets the access control policy on the specified resource. Replaces any existing policy.
Args:
- resource: string, REQUIRED: The resource for which policy is being specified. Usually some path like projects/{project}/zones/{zone}/disks/{disk}. (required)
+ resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # # Overview The `Policy` defines an access control policy language. It can be used to define policies that can be attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members can include user accounts, user groups, user domains, and service accounts. A role is a named set of permissions, defined by the IAM system. The definition of a role is outside the policy. A permission check involves determining the roles that include the specified permission, and then determining if the principal specified by the check is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group::admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ``` # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
- "rules": [
- { # A rule to be applied in a Policy.
- "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The formation for in and not_in entries is the same as members in a Binding above.
- "A String",
- ],
- "description": "A String", # Human-readable description of the rule.
- "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
- "A String",
- ],
- "action": "A String", # Required
- "conditions": [ # Additional restrictions that must be met
- { # A condition to be met.
- "iam": "A String", # Trusted attributes supplied by the IAM system.
- "svc": "A String", # Trusted attributes discharged by the service.
- "value": "A String", # The object of the condition. Exactly one of these must be set.
- "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
- "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
- "A String",
- ],
- "op": "A String", # An operator to apply the subject with.
- },
- ],
- "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
- { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
- "counter": { # Options for counters # Counter options.
- "field": "A String", # The field value to attribute.
- "metric": "A String", # The metric to update.
- },
- "dataAccess": { # Write a Data Access (Gin) log # Data access options.
- },
- "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
- },
- },
- ],
- "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
},
],
- "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
- { # Associates members of various types with roles. See below for details of the various objects that can be included as members.
- "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
- "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
- "A String",
- ],
- },
- ],
- "version": 42, # The policy language version. The version of the policy itself is represented by the etag. The current version is 0.
- "etag": "A String", # Can be used to perform a read-modify-write.
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
},
}
@@ -363,56 +286,17 @@
Returns:
An object of the form:
- { # # Overview The `Policy` defines an access control policy language. It can be used to define policies that can be attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members can include user accounts, user groups, user domains, and service accounts. A role is a named set of permissions, defined by the IAM system. The definition of a role is outside the policy. A permission check involves determining the roles that include the specified permission, and then determining if the principal specified by the check is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group::admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ```
- "rules": [
- { # A rule to be applied in a Policy.
- "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The formation for in and not_in entries is the same as members in a Binding above.
- "A String",
- ],
- "description": "A String", # Human-readable description of the rule.
- "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
- "A String",
- ],
- "action": "A String", # Required
- "conditions": [ # Additional restrictions that must be met
- { # A condition to be met.
- "iam": "A String", # Trusted attributes supplied by the IAM system.
- "svc": "A String", # Trusted attributes discharged by the service.
- "value": "A String", # The object of the condition. Exactly one of these must be set.
- "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
- "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
- "A String",
- ],
- "op": "A String", # An operator to apply the subject with.
- },
- ],
- "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
- { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
- "counter": { # Options for counters # Counter options.
- "field": "A String", # The field value to attribute.
- "metric": "A String", # The metric to update.
- },
- "dataAccess": { # Write a Data Access (Gin) log # Data access options.
- },
- "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
- },
- },
- ],
- "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
+ "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
},
],
- "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
- { # Associates members of various types with roles. See below for details of the various objects that can be included as members.
- "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
- "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
- "A String",
- ],
- },
- ],
- "version": 42, # The policy language version. The version of the policy itself is represented by the etag. The current version is 0.
- "etag": "A String", # Can be used to perform a read-modify-write.
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
}</pre>
</div>
@@ -421,12 +305,12 @@
<pre>Returns permissions that a caller has on the specified resource.
Args:
- resource: string, REQUIRED: The resource for which policy detail is being requested. Usually some path like projects/{project}. (required)
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
diff --git a/docs/dyn/pubsub_v1beta2.projects.topics.subscriptions.html b/docs/dyn/pubsub_v1beta2.projects.topics.subscriptions.html
index 5091d5a..1bb1547 100644
--- a/docs/dyn/pubsub_v1beta2.projects.topics.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta2.projects.topics.subscriptions.html
@@ -88,14 +88,14 @@
Args:
topic: string, The name of the topic that subscriptions are attached to. (required)
pageSize: integer, Maximum number of subscription names to return.
- pageToken: string, The value returned by the last ListTopicSubscriptionsResponse; indicates that this is a continuation of a prior ListTopicSubscriptions call, and that the system should return the next page of data.
+ pageToken: string, The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data.
x__xgafv: string, V1 error format.
Returns:
An object of the form:
- { # Response for the ListTopicSubscriptions method.
- "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new ListTopicSubscriptionsRequest to get more subscriptions.
+ { # Response for the `ListTopicSubscriptions` method.
+ "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions.
"subscriptions": [ # The names of the subscriptions that match the request.
"A String",
],
diff --git a/docs/dyn/replicapool_v1beta1.html b/docs/dyn/replicapool_v1beta1.html
index 676a9d0..4f21690 100644
--- a/docs/dyn/replicapool_v1beta1.html
+++ b/docs/dyn/replicapool_v1beta1.html
@@ -84,4 +84,25 @@
</p>
<p class="firstline">Returns the replicas Resource.</p>
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/resourceviews_v1beta1.html b/docs/dyn/resourceviews_v1beta1.html
index 1670c6a..2098d74 100644
--- a/docs/dyn/resourceviews_v1beta1.html
+++ b/docs/dyn/resourceviews_v1beta1.html
@@ -84,4 +84,25 @@
</p>
<p class="firstline">Returns the zoneViews Resource.</p>
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/logging_v1beta3.html b/docs/dyn/runtimeconfig_v1.html
similarity index 90%
copy from docs/dyn/logging_v1beta3.html
copy to docs/dyn/runtimeconfig_v1.html
index db3cf63..8ce343e 100644
--- a/docs/dyn/logging_v1beta3.html
+++ b/docs/dyn/runtimeconfig_v1.html
@@ -72,12 +72,12 @@
</style>
-<h1><a href="logging_v1beta3.html">Google Cloud Logging API</a></h1>
+<h1><a href="runtimeconfig_v1.html">Google Cloud RuntimeConfig API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="logging_v1beta3.projects.html">projects()</a></code>
+ <code><a href="runtimeconfig_v1.operations.html">operations()</a></code>
</p>
-<p class="firstline">Returns the projects Resource.</p>
+<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/runtimeconfig_v1.operations.html b/docs/dyn/runtimeconfig_v1.operations.html
new file mode 100644
index 0000000..21651dc
--- /dev/null
+++ b/docs/dyn/runtimeconfig_v1.operations.html
@@ -0,0 +1,290 @@
+<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="runtimeconfig_v1.html">Google Cloud RuntimeConfig API</a> . <a href="runtimeconfig_v1.operations.html">operations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#cancel">cancel(name, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a long-running operation. This method indicates that the client is</p>
+<p class="toc_element">
+ <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists operations that match the specified filter in the request. If the</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="cancel">cancel(name, body, x__xgafv=None)</code>
+ <pre>Starts asynchronous cancellation on a long-running operation. The server
+makes a best effort to cancel the operation, but success is not
+guaranteed. If the server doesn't support this method, it returns
+`google.rpc.Code.UNIMPLEMENTED`. Clients can use
+Operations.GetOperation or
+other methods to check whether the cancellation succeeded or whether the
+operation completed despite cancellation. On successful cancellation,
+the operation is not deleted; instead, it becomes an operation with
+an Operation.error value with a google.rpc.Status.code of 1,
+corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>Deletes a long-running operation. This method indicates that the client is
+no longer interested in the operation result. It does not cancel the
+operation. If the server doesn't support this method, it returns
+`google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists operations that match the specified filter in the request. If the
+server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+NOTE: the `name` binding below allows API services to override the binding
+to use different resource name schemes, such as `users/*/operations`.
+
+Args:
+ name: string, The name of the operation collection. (required)
+ pageSize: integer, The standard list page size.
+ filter: string, The standard list filter.
+ pageToken: string, The standard list page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If true, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should have the format of `operations/some/unique/name`.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
+ # programming environments, including REST APIs and RPC APIs. It is used by
+ # [gRPC](https://github.com/grpc). The error model is designed to be:
+ #
+ # - Simple to use and understand for most users
+ # - Flexible enough to meet unexpected needs
+ #
+ # # Overview
+ #
+ # The `Status` message contains three pieces of data: error code, error message,
+ # and error details. The error code should be an enum value of
+ # google.rpc.Code, but it may accept additional error codes if needed. The
+ # error message should be a developer-facing English message that helps
+ # developers *understand* and *resolve* the error. If a localized user-facing
+ # error message is needed, put the localized message in the error details or
+ # localize it in the client. The optional error details may contain arbitrary
+ # information about the error. There is a predefined set of error detail types
+ # in the package `google.rpc` which can be used for common error conditions.
+ #
+ # # Language mapping
+ #
+ # The `Status` message is the logical representation of the error model, but it
+ # is not necessarily the actual wire format. When the `Status` message is
+ # exposed in different client libraries and different wire protocols, it can be
+ # mapped differently. For example, it will likely be mapped to some exceptions
+ # in Java, but more likely mapped to some error codes in C.
+ #
+ # # Other uses
+ #
+ # The error model and the `Status` message can be used in a variety of
+ # environments, either with or without APIs, to provide a
+ # consistent developer experience across different environments.
+ #
+ # Example uses of this error model include:
+ #
+ # - Partial errors. If a service needs to return partial errors to the client,
+ # it may embed the `Status` in the normal response to indicate the partial
+ # errors.
+ #
+ # - Workflow errors. A typical workflow has multiple steps. Each step may
+ # have a `Status` message for error reporting purpose.
+ #
+ # - Batch operations. If a client uses batch request and batch response, the
+ # `Status` message should be used directly inside batch response, one for
+ # each error sub-response.
+ #
+ # - Asynchronous operations. If an API call embeds asynchronous operation
+ # results in its response, the status of those operations should be
+ # represented directly using the `Status` message.
+ #
+ # - Logging. If some API errors are stored in logs, the message `Status` could
+ # be used directly after any stripping needed for security/privacy reasons.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a
+ # common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ },
+ ],
+ }</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>
\ No newline at end of file
diff --git a/docs/dyn/runtimeconfig_v1beta1.projects.configs.operations.html b/docs/dyn/runtimeconfig_v1beta1.projects.configs.operations.html
index 3283f3d..3ce5357 100644
--- a/docs/dyn/runtimeconfig_v1beta1.projects.configs.operations.html
+++ b/docs/dyn/runtimeconfig_v1beta1.projects.configs.operations.html
@@ -118,7 +118,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
diff --git a/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html b/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html
index 57c2c09..90e131b 100644
--- a/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html
+++ b/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html
@@ -295,7 +295,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
diff --git a/docs/dyn/servicemanagement_v1.operations.html b/docs/dyn/servicemanagement_v1.operations.html
index cd22ab3..3ff1302 100644
--- a/docs/dyn/servicemanagement_v1.operations.html
+++ b/docs/dyn/servicemanagement_v1.operations.html
@@ -118,7 +118,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html
index 76ab8a1..68ed0ea 100644
--- a/docs/dyn/servicemanagement_v1.services.configs.html
+++ b/docs/dyn/servicemanagement_v1.services.configs.html
@@ -192,6 +192,56 @@
# slash, underscore, hyphen, period [/_-.].
},
],
+ "analytics": { # Analytics configuration of the service. # WARNING: DO NOT USE UNTIL THIS MESSAGE IS REMOVED.
+ #
+ # Analytics configuration.
+ #
+ # The example below shows how to configure monitored resources and metrics
+ # for analytics. In the example, a monitored resource and two metrics are
+ # defined. The `library.googleapis.com/book/returned_count` and
+ # `library.googleapis.com/book/overdue_count` metric are sent
+ # to the analytics.
+ #
+ # monitored_resources:
+ # - type: library.googleapis.com/branch
+ # labels:
+ # - key: /city
+ # description: The city where the library branch is located in.
+ # - key: /name
+ # description: The name of the branch.
+ # metrics:
+ # - name: library.googleapis.com/book/returned_count
+ # metric_kind: DELTA
+ # value_type: INT64
+ # labels:
+ # - key: /customer_id
+ # - name: library.googleapis.com/book/overdue_count
+ # metric_kind: GAUGE
+ # value_type: INT64
+ # labels:
+ # - key: /customer_id
+ # analytics:
+ # producer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # metrics:
+ # - library.googleapis.com/book/returned_count
+ # - library.googleapis.com/book/overdue_count
+ "producerDestinations": [ # Analytics configurations for sending metrics to the analytics backend.
+ # There can be multiple producer destinations, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one producer destination.
+ { # Configuration of a specific analytics destination.
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this analytics destination.
+ # Each name must be defined in Service.metrics section. Metrics
+ # with value type BOOL and STRING must be of GUAGE kind, metrics with
+ # value type INT64, DOUBLE and MONEY must be of DELTA kind.
+ "A String",
+ ],
+ },
+ ],
+ },
"systemParameters": { # ### System parameter configuration # System parameter configuration.
#
# A system parameter is a special kind of parameter defined by the API
@@ -1170,11 +1220,9 @@
"logging": { # Logging configuration of the service. # Logging configuration.
#
# The following example shows how to configure logs to be sent to the
- # producer and consumer projects. In the example,
- # the `library.googleapis.com/activity_history` log is
- # sent to both the producer and consumer projects, whereas
- # the `library.googleapis.com/purchase_history` log is only sent to the
- # producer project:
+ # producer and consumer projects. In the example, the `activity_history`
+ # log is sent to both the producer and consumer projects, whereas the
+ # `purchase_history` log is only sent to the producer project.
#
# monitored_resources:
# - type: library.googleapis.com/branch
@@ -1184,30 +1232,32 @@
# - key: /name
# description: The name of the branch.
# logs:
- # - name: library.googleapis.com/activity_history
+ # - name: activity_history
# labels:
# - key: /customer_id
- # - name: library.googleapis.com/purchase_history
+ # - name: purchase_history
# logging:
# producer_destinations:
# - monitored_resource: library.googleapis.com/branch
# logs:
- # - library.googleapis.com/activity_history
- # - library.googleapis.com/purchase_history
+ # - activity_history
+ # - purchase_history
# consumer_destinations:
# - monitored_resource: library.googleapis.com/branch
# logs:
- # - library.googleapis.com/activity_history
+ # - activity_history
"producerDestinations": [ # Logging configurations for sending logs to the producer project.
# There can be multiple producer destinations, each one must have a
# different monitored resource type. A log can be used in at most
# one producer destination.
{ # Configuration of a specific logging destination (the producer project
# or the consumer project).
- "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
# Service.monitored_resources section.
"logs": [ # Names of the logs to be sent to this destination. Each name must
- # be defined in the Service.logs section.
+ # be defined in the Service.logs section. If the log name is
+ # not a domain scoped name, it will be automatically prefixed with
+ # the service name followed by "/".
"A String",
],
},
@@ -1218,10 +1268,12 @@
# one consumer destination.
{ # Configuration of a specific logging destination (the producer project
# or the consumer project).
- "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
# Service.monitored_resources section.
"logs": [ # Names of the logs to be sent to this destination. Each name must
- # be defined in the Service.logs section.
+ # be defined in the Service.logs section. If the log name is
+ # not a domain scoped name, it will be automatically prefixed with
+ # the service name followed by "/".
"A String",
],
},
@@ -1590,6 +1642,56 @@
# slash, underscore, hyphen, period [/_-.].
},
],
+ "analytics": { # Analytics configuration of the service. # WARNING: DO NOT USE UNTIL THIS MESSAGE IS REMOVED.
+ #
+ # Analytics configuration.
+ #
+ # The example below shows how to configure monitored resources and metrics
+ # for analytics. In the example, a monitored resource and two metrics are
+ # defined. The `library.googleapis.com/book/returned_count` and
+ # `library.googleapis.com/book/overdue_count` metric are sent
+ # to the analytics.
+ #
+ # monitored_resources:
+ # - type: library.googleapis.com/branch
+ # labels:
+ # - key: /city
+ # description: The city where the library branch is located in.
+ # - key: /name
+ # description: The name of the branch.
+ # metrics:
+ # - name: library.googleapis.com/book/returned_count
+ # metric_kind: DELTA
+ # value_type: INT64
+ # labels:
+ # - key: /customer_id
+ # - name: library.googleapis.com/book/overdue_count
+ # metric_kind: GAUGE
+ # value_type: INT64
+ # labels:
+ # - key: /customer_id
+ # analytics:
+ # producer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # metrics:
+ # - library.googleapis.com/book/returned_count
+ # - library.googleapis.com/book/overdue_count
+ "producerDestinations": [ # Analytics configurations for sending metrics to the analytics backend.
+ # There can be multiple producer destinations, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one producer destination.
+ { # Configuration of a specific analytics destination.
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this analytics destination.
+ # Each name must be defined in Service.metrics section. Metrics
+ # with value type BOOL and STRING must be of GUAGE kind, metrics with
+ # value type INT64, DOUBLE and MONEY must be of DELTA kind.
+ "A String",
+ ],
+ },
+ ],
+ },
"systemParameters": { # ### System parameter configuration # System parameter configuration.
#
# A system parameter is a special kind of parameter defined by the API
@@ -2568,11 +2670,9 @@
"logging": { # Logging configuration of the service. # Logging configuration.
#
# The following example shows how to configure logs to be sent to the
- # producer and consumer projects. In the example,
- # the `library.googleapis.com/activity_history` log is
- # sent to both the producer and consumer projects, whereas
- # the `library.googleapis.com/purchase_history` log is only sent to the
- # producer project:
+ # producer and consumer projects. In the example, the `activity_history`
+ # log is sent to both the producer and consumer projects, whereas the
+ # `purchase_history` log is only sent to the producer project.
#
# monitored_resources:
# - type: library.googleapis.com/branch
@@ -2582,30 +2682,32 @@
# - key: /name
# description: The name of the branch.
# logs:
- # - name: library.googleapis.com/activity_history
+ # - name: activity_history
# labels:
# - key: /customer_id
- # - name: library.googleapis.com/purchase_history
+ # - name: purchase_history
# logging:
# producer_destinations:
# - monitored_resource: library.googleapis.com/branch
# logs:
- # - library.googleapis.com/activity_history
- # - library.googleapis.com/purchase_history
+ # - activity_history
+ # - purchase_history
# consumer_destinations:
# - monitored_resource: library.googleapis.com/branch
# logs:
- # - library.googleapis.com/activity_history
+ # - activity_history
"producerDestinations": [ # Logging configurations for sending logs to the producer project.
# There can be multiple producer destinations, each one must have a
# different monitored resource type. A log can be used in at most
# one producer destination.
{ # Configuration of a specific logging destination (the producer project
# or the consumer project).
- "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
# Service.monitored_resources section.
"logs": [ # Names of the logs to be sent to this destination. Each name must
- # be defined in the Service.logs section.
+ # be defined in the Service.logs section. If the log name is
+ # not a domain scoped name, it will be automatically prefixed with
+ # the service name followed by "/".
"A String",
],
},
@@ -2616,10 +2718,12 @@
# one consumer destination.
{ # Configuration of a specific logging destination (the producer project
# or the consumer project).
- "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
# Service.monitored_resources section.
"logs": [ # Names of the logs to be sent to this destination. Each name must
- # be defined in the Service.logs section.
+ # be defined in the Service.logs section. If the log name is
+ # not a domain scoped name, it will be automatically prefixed with
+ # the service name followed by "/".
"A String",
],
},
@@ -2997,6 +3101,56 @@
# slash, underscore, hyphen, period [/_-.].
},
],
+ "analytics": { # Analytics configuration of the service. # WARNING: DO NOT USE UNTIL THIS MESSAGE IS REMOVED.
+ #
+ # Analytics configuration.
+ #
+ # The example below shows how to configure monitored resources and metrics
+ # for analytics. In the example, a monitored resource and two metrics are
+ # defined. The `library.googleapis.com/book/returned_count` and
+ # `library.googleapis.com/book/overdue_count` metric are sent
+ # to the analytics.
+ #
+ # monitored_resources:
+ # - type: library.googleapis.com/branch
+ # labels:
+ # - key: /city
+ # description: The city where the library branch is located in.
+ # - key: /name
+ # description: The name of the branch.
+ # metrics:
+ # - name: library.googleapis.com/book/returned_count
+ # metric_kind: DELTA
+ # value_type: INT64
+ # labels:
+ # - key: /customer_id
+ # - name: library.googleapis.com/book/overdue_count
+ # metric_kind: GAUGE
+ # value_type: INT64
+ # labels:
+ # - key: /customer_id
+ # analytics:
+ # producer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # metrics:
+ # - library.googleapis.com/book/returned_count
+ # - library.googleapis.com/book/overdue_count
+ "producerDestinations": [ # Analytics configurations for sending metrics to the analytics backend.
+ # There can be multiple producer destinations, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one producer destination.
+ { # Configuration of a specific analytics destination.
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this analytics destination.
+ # Each name must be defined in Service.metrics section. Metrics
+ # with value type BOOL and STRING must be of GUAGE kind, metrics with
+ # value type INT64, DOUBLE and MONEY must be of DELTA kind.
+ "A String",
+ ],
+ },
+ ],
+ },
"systemParameters": { # ### System parameter configuration # System parameter configuration.
#
# A system parameter is a special kind of parameter defined by the API
@@ -3975,11 +4129,9 @@
"logging": { # Logging configuration of the service. # Logging configuration.
#
# The following example shows how to configure logs to be sent to the
- # producer and consumer projects. In the example,
- # the `library.googleapis.com/activity_history` log is
- # sent to both the producer and consumer projects, whereas
- # the `library.googleapis.com/purchase_history` log is only sent to the
- # producer project:
+ # producer and consumer projects. In the example, the `activity_history`
+ # log is sent to both the producer and consumer projects, whereas the
+ # `purchase_history` log is only sent to the producer project.
#
# monitored_resources:
# - type: library.googleapis.com/branch
@@ -3989,30 +4141,32 @@
# - key: /name
# description: The name of the branch.
# logs:
- # - name: library.googleapis.com/activity_history
+ # - name: activity_history
# labels:
# - key: /customer_id
- # - name: library.googleapis.com/purchase_history
+ # - name: purchase_history
# logging:
# producer_destinations:
# - monitored_resource: library.googleapis.com/branch
# logs:
- # - library.googleapis.com/activity_history
- # - library.googleapis.com/purchase_history
+ # - activity_history
+ # - purchase_history
# consumer_destinations:
# - monitored_resource: library.googleapis.com/branch
# logs:
- # - library.googleapis.com/activity_history
+ # - activity_history
"producerDestinations": [ # Logging configurations for sending logs to the producer project.
# There can be multiple producer destinations, each one must have a
# different monitored resource type. A log can be used in at most
# one producer destination.
{ # Configuration of a specific logging destination (the producer project
# or the consumer project).
- "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
# Service.monitored_resources section.
"logs": [ # Names of the logs to be sent to this destination. Each name must
- # be defined in the Service.logs section.
+ # be defined in the Service.logs section. If the log name is
+ # not a domain scoped name, it will be automatically prefixed with
+ # the service name followed by "/".
"A String",
],
},
@@ -4023,10 +4177,12 @@
# one consumer destination.
{ # Configuration of a specific logging destination (the producer project
# or the consumer project).
- "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
# Service.monitored_resources section.
"logs": [ # Names of the logs to be sent to this destination. Each name must
- # be defined in the Service.logs section.
+ # be defined in the Service.logs section. If the log name is
+ # not a domain scoped name, it will be automatically prefixed with
+ # the service name followed by "/".
"A String",
],
},
@@ -4409,6 +4565,56 @@
# slash, underscore, hyphen, period [/_-.].
},
],
+ "analytics": { # Analytics configuration of the service. # WARNING: DO NOT USE UNTIL THIS MESSAGE IS REMOVED.
+ #
+ # Analytics configuration.
+ #
+ # The example below shows how to configure monitored resources and metrics
+ # for analytics. In the example, a monitored resource and two metrics are
+ # defined. The `library.googleapis.com/book/returned_count` and
+ # `library.googleapis.com/book/overdue_count` metric are sent
+ # to the analytics.
+ #
+ # monitored_resources:
+ # - type: library.googleapis.com/branch
+ # labels:
+ # - key: /city
+ # description: The city where the library branch is located in.
+ # - key: /name
+ # description: The name of the branch.
+ # metrics:
+ # - name: library.googleapis.com/book/returned_count
+ # metric_kind: DELTA
+ # value_type: INT64
+ # labels:
+ # - key: /customer_id
+ # - name: library.googleapis.com/book/overdue_count
+ # metric_kind: GAUGE
+ # value_type: INT64
+ # labels:
+ # - key: /customer_id
+ # analytics:
+ # producer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # metrics:
+ # - library.googleapis.com/book/returned_count
+ # - library.googleapis.com/book/overdue_count
+ "producerDestinations": [ # Analytics configurations for sending metrics to the analytics backend.
+ # There can be multiple producer destinations, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one producer destination.
+ { # Configuration of a specific analytics destination.
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this analytics destination.
+ # Each name must be defined in Service.metrics section. Metrics
+ # with value type BOOL and STRING must be of GUAGE kind, metrics with
+ # value type INT64, DOUBLE and MONEY must be of DELTA kind.
+ "A String",
+ ],
+ },
+ ],
+ },
"systemParameters": { # ### System parameter configuration # System parameter configuration.
#
# A system parameter is a special kind of parameter defined by the API
@@ -5387,11 +5593,9 @@
"logging": { # Logging configuration of the service. # Logging configuration.
#
# The following example shows how to configure logs to be sent to the
- # producer and consumer projects. In the example,
- # the `library.googleapis.com/activity_history` log is
- # sent to both the producer and consumer projects, whereas
- # the `library.googleapis.com/purchase_history` log is only sent to the
- # producer project:
+ # producer and consumer projects. In the example, the `activity_history`
+ # log is sent to both the producer and consumer projects, whereas the
+ # `purchase_history` log is only sent to the producer project.
#
# monitored_resources:
# - type: library.googleapis.com/branch
@@ -5401,30 +5605,32 @@
# - key: /name
# description: The name of the branch.
# logs:
- # - name: library.googleapis.com/activity_history
+ # - name: activity_history
# labels:
# - key: /customer_id
- # - name: library.googleapis.com/purchase_history
+ # - name: purchase_history
# logging:
# producer_destinations:
# - monitored_resource: library.googleapis.com/branch
# logs:
- # - library.googleapis.com/activity_history
- # - library.googleapis.com/purchase_history
+ # - activity_history
+ # - purchase_history
# consumer_destinations:
# - monitored_resource: library.googleapis.com/branch
# logs:
- # - library.googleapis.com/activity_history
+ # - activity_history
"producerDestinations": [ # Logging configurations for sending logs to the producer project.
# There can be multiple producer destinations, each one must have a
# different monitored resource type. A log can be used in at most
# one producer destination.
{ # Configuration of a specific logging destination (the producer project
# or the consumer project).
- "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
# Service.monitored_resources section.
"logs": [ # Names of the logs to be sent to this destination. Each name must
- # be defined in the Service.logs section.
+ # be defined in the Service.logs section. If the log name is
+ # not a domain scoped name, it will be automatically prefixed with
+ # the service name followed by "/".
"A String",
],
},
@@ -5435,10 +5641,12 @@
# one consumer destination.
{ # Configuration of a specific logging destination (the producer project
# or the consumer project).
- "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
# Service.monitored_resources section.
"logs": [ # Names of the logs to be sent to this destination. Each name must
- # be defined in the Service.logs section.
+ # be defined in the Service.logs section. If the log name is
+ # not a domain scoped name, it will be automatically prefixed with
+ # the service name followed by "/".
"A String",
],
},
@@ -5797,7 +6005,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html
index 758a05b..31cfe5b 100644
--- a/docs/dyn/servicemanagement_v1.services.html
+++ b/docs/dyn/servicemanagement_v1.services.html
@@ -174,7 +174,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
@@ -284,7 +284,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
@@ -405,7 +405,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
@@ -529,7 +529,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
@@ -824,6 +824,56 @@
# slash, underscore, hyphen, period [/_-.].
},
],
+ "analytics": { # Analytics configuration of the service. # WARNING: DO NOT USE UNTIL THIS MESSAGE IS REMOVED.
+ #
+ # Analytics configuration.
+ #
+ # The example below shows how to configure monitored resources and metrics
+ # for analytics. In the example, a monitored resource and two metrics are
+ # defined. The `library.googleapis.com/book/returned_count` and
+ # `library.googleapis.com/book/overdue_count` metric are sent
+ # to the analytics.
+ #
+ # monitored_resources:
+ # - type: library.googleapis.com/branch
+ # labels:
+ # - key: /city
+ # description: The city where the library branch is located in.
+ # - key: /name
+ # description: The name of the branch.
+ # metrics:
+ # - name: library.googleapis.com/book/returned_count
+ # metric_kind: DELTA
+ # value_type: INT64
+ # labels:
+ # - key: /customer_id
+ # - name: library.googleapis.com/book/overdue_count
+ # metric_kind: GAUGE
+ # value_type: INT64
+ # labels:
+ # - key: /customer_id
+ # analytics:
+ # producer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # metrics:
+ # - library.googleapis.com/book/returned_count
+ # - library.googleapis.com/book/overdue_count
+ "producerDestinations": [ # Analytics configurations for sending metrics to the analytics backend.
+ # There can be multiple producer destinations, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one producer destination.
+ { # Configuration of a specific analytics destination.
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this analytics destination.
+ # Each name must be defined in Service.metrics section. Metrics
+ # with value type BOOL and STRING must be of GUAGE kind, metrics with
+ # value type INT64, DOUBLE and MONEY must be of DELTA kind.
+ "A String",
+ ],
+ },
+ ],
+ },
"systemParameters": { # ### System parameter configuration # System parameter configuration.
#
# A system parameter is a special kind of parameter defined by the API
@@ -1802,11 +1852,9 @@
"logging": { # Logging configuration of the service. # Logging configuration.
#
# The following example shows how to configure logs to be sent to the
- # producer and consumer projects. In the example,
- # the `library.googleapis.com/activity_history` log is
- # sent to both the producer and consumer projects, whereas
- # the `library.googleapis.com/purchase_history` log is only sent to the
- # producer project:
+ # producer and consumer projects. In the example, the `activity_history`
+ # log is sent to both the producer and consumer projects, whereas the
+ # `purchase_history` log is only sent to the producer project.
#
# monitored_resources:
# - type: library.googleapis.com/branch
@@ -1816,30 +1864,32 @@
# - key: /name
# description: The name of the branch.
# logs:
- # - name: library.googleapis.com/activity_history
+ # - name: activity_history
# labels:
# - key: /customer_id
- # - name: library.googleapis.com/purchase_history
+ # - name: purchase_history
# logging:
# producer_destinations:
# - monitored_resource: library.googleapis.com/branch
# logs:
- # - library.googleapis.com/activity_history
- # - library.googleapis.com/purchase_history
+ # - activity_history
+ # - purchase_history
# consumer_destinations:
# - monitored_resource: library.googleapis.com/branch
# logs:
- # - library.googleapis.com/activity_history
+ # - activity_history
"producerDestinations": [ # Logging configurations for sending logs to the producer project.
# There can be multiple producer destinations, each one must have a
# different monitored resource type. A log can be used in at most
# one producer destination.
{ # Configuration of a specific logging destination (the producer project
# or the consumer project).
- "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
# Service.monitored_resources section.
"logs": [ # Names of the logs to be sent to this destination. Each name must
- # be defined in the Service.logs section.
+ # be defined in the Service.logs section. If the log name is
+ # not a domain scoped name, it will be automatically prefixed with
+ # the service name followed by "/".
"A String",
],
},
@@ -1850,10 +1900,12 @@
# one consumer destination.
{ # Configuration of a specific logging destination (the producer project
# or the consumer project).
- "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
# Service.monitored_resources section.
"logs": [ # Names of the logs to be sent to this destination. Each name must
- # be defined in the Service.logs section.
+ # be defined in the Service.logs section. If the log name is
+ # not a domain scoped name, it will be automatically prefixed with
+ # the service name followed by "/".
"A String",
],
},
@@ -2307,6 +2359,7 @@
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@gmail.com` or `joe@example.com`.
#
+ #
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
@@ -2541,6 +2594,7 @@
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@gmail.com` or `joe@example.com`.
#
+ #
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
@@ -2723,6 +2777,7 @@
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@gmail.com` or `joe@example.com`.
#
+ #
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
@@ -2820,7 +2875,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
diff --git a/docs/dyn/servicemanagement_v1.services.rollouts.html b/docs/dyn/servicemanagement_v1.services.rollouts.html
index 9d19f1c..28e89a5 100644
--- a/docs/dyn/servicemanagement_v1.services.rollouts.html
+++ b/docs/dyn/servicemanagement_v1.services.rollouts.html
@@ -197,7 +197,7 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
- "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
diff --git a/docs/dyn/sheets_v4.spreadsheets.html b/docs/dyn/sheets_v4.spreadsheets.html
index 79f396b..cd507af 100644
--- a/docs/dyn/sheets_v4.spreadsheets.html
+++ b/docs/dyn/sheets_v4.spreadsheets.html
@@ -702,7 +702,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -836,7 +836,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -970,7 +970,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -1104,7 +1104,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -2480,7 +2480,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -2614,7 +2614,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -2748,7 +2748,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -2882,7 +2882,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -3309,7 +3309,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -3443,7 +3443,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -3577,7 +3577,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -3711,7 +3711,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -5021,7 +5021,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -5155,7 +5155,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -5289,7 +5289,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -5423,7 +5423,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -6541,7 +6541,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -6675,7 +6675,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -6809,7 +6809,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -6943,7 +6943,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -7370,7 +7370,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -7504,7 +7504,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -7638,7 +7638,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -7772,7 +7772,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -8579,7 +8579,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -8713,7 +8713,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -8847,7 +8847,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -8981,7 +8981,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -9716,7 +9716,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -9850,7 +9850,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -9984,7 +9984,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -10118,7 +10118,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -10545,7 +10545,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -10679,7 +10679,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -10813,7 +10813,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -10947,7 +10947,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -12209,7 +12209,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The border to put at the bottom of the range.
@@ -12343,7 +12343,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"top": { # A border along a cell. # The border to put at the top of the range.
@@ -12477,7 +12477,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"innerHorizontal": { # A border along a cell. # The horizontal border to put within the range.
@@ -12611,7 +12611,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"range": { # A range on a sheet. # The range whose borders should be updated.
@@ -12780,7 +12780,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The border to put at the left of the range.
@@ -12914,7 +12914,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -14603,7 +14603,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -14737,7 +14737,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -14871,7 +14871,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -15005,7 +15005,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -15920,7 +15920,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -16054,7 +16054,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -16188,7 +16188,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -16322,7 +16322,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -17556,7 +17556,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -17690,7 +17690,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -17824,7 +17824,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -17958,7 +17958,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -18967,7 +18967,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -19101,7 +19101,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -19235,7 +19235,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -19369,7 +19369,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -19870,7 +19870,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -20004,7 +20004,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -20138,7 +20138,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -20272,7 +20272,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -22183,7 +22183,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -22317,7 +22317,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -22451,7 +22451,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -22585,7 +22585,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -23012,7 +23012,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -23146,7 +23146,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -23280,7 +23280,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -23414,7 +23414,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -24256,7 +24256,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -24390,7 +24390,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -24524,7 +24524,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -24658,7 +24658,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -25159,7 +25159,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -25293,7 +25293,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -25427,7 +25427,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -25561,7 +25561,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -27472,7 +27472,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -27606,7 +27606,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -27740,7 +27740,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -27874,7 +27874,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -28301,7 +28301,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -28435,7 +28435,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -28569,7 +28569,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -28703,7 +28703,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -29575,7 +29575,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -29709,7 +29709,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -29843,7 +29843,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -29977,7 +29977,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -30478,7 +30478,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -30612,7 +30612,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -30746,7 +30746,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -30880,7 +30880,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -32791,7 +32791,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -32925,7 +32925,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -33059,7 +33059,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -33193,7 +33193,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
@@ -33620,7 +33620,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"right": { # A border along a cell. # The right border of the cell.
@@ -33754,7 +33754,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"bottom": { # A border along a cell. # The bottom border of the cell.
@@ -33888,7 +33888,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
"left": { # A border along a cell. # The left border of the cell.
@@ -34022,7 +34022,7 @@
"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
},
"width": 42, # The width of the border, in pixels.
- # Border widths must be between 0 and 3 pixels, inclusive.
+ # Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
},
diff --git a/docs/dyn/sheets_v4.spreadsheets.values.html b/docs/dyn/sheets_v4.spreadsheets.values.html
index 6e051eb..f8d20f2 100644
--- a/docs/dyn/sheets_v4.spreadsheets.values.html
+++ b/docs/dyn/sheets_v4.spreadsheets.values.html
@@ -78,12 +78,18 @@
<code><a href="#append">append(spreadsheetId, range=None, body, insertDataOption=None, valueInputOption=None, x__xgafv=None)</a></code></p>
<p class="firstline">Appends values to a spreadsheet. The input range is used to search for</p>
<p class="toc_element">
+ <code><a href="#batchClear">batchClear(spreadsheetId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Clears one or more ranges of values from a spreadsheet.</p>
+<p class="toc_element">
<code><a href="#batchGet">batchGet(spreadsheetId, valueRenderOption=None, majorDimension=None, ranges=None, dateTimeRenderOption=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns one or more ranges of values from a spreadsheet.</p>
<p class="toc_element">
<code><a href="#batchUpdate">batchUpdate(spreadsheetId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Sets values in one or more ranges of a spreadsheet.</p>
<p class="toc_element">
+ <code><a href="#clear">clear(spreadsheetId, range, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Clears values from a spreadsheet.</p>
+<p class="toc_element">
<code><a href="#get">get(spreadsheetId, range, valueRenderOption=None, majorDimension=None, dateTimeRenderOption=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a range of values from a spreadsheet.</p>
<p class="toc_element">
@@ -175,6 +181,43 @@
</div>
<div class="method">
+ <code class="details" id="batchClear">batchClear(spreadsheetId, body, x__xgafv=None)</code>
+ <pre>Clears one or more ranges of values from a spreadsheet.
+The caller must specify the spreadsheet ID and one or more ranges.
+Only values are cleared -- all other properties of the cell (such as
+formatting, data validation, etc..) are kept.
+
+Args:
+ spreadsheetId: string, The ID of the spreadsheet to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request for clearing more than one range of values in a spreadsheet.
+ "ranges": [ # The ranges to clear, in A1 notation.
+ "A String",
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response when updating a range of values in a spreadsheet.
+ "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
+ "clearedRanges": [ # The ranges that were cleared, in A1 notation.
+ # (If the requests were for an unbounded range or a ranger larger
+ # than the bounds of the sheet, this will be the actual ranges
+ # that were cleared, bounded to the sheet's limits.)
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="batchGet">batchGet(spreadsheetId, valueRenderOption=None, majorDimension=None, ranges=None, dateTimeRenderOption=None, x__xgafv=None)</code>
<pre>Returns one or more ranges of values from a spreadsheet.
The caller must specify the spreadsheet ID and one or more ranges.
@@ -325,6 +368,39 @@
</div>
<div class="method">
+ <code class="details" id="clear">clear(spreadsheetId, range, body, x__xgafv=None)</code>
+ <pre>Clears values from a spreadsheet.
+The caller must specify the spreadsheet ID and range.
+Only values are cleared -- all other properties of the cell (such as
+formatting, data validation, etc..) are kept.
+
+Args:
+ spreadsheetId: string, The ID of the spreadsheet to update. (required)
+ range: string, The A1 notation of the values to clear. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request for clearing a range of values in a spreadsheet.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response when clearing a range of values in a spreadsheet.
+ "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
+ "clearedRange": "A String", # The range (in A1 notation) that was cleared.
+ # (If the request was for an unbounded range or a ranger larger
+ # than the bounds of the sheet, this will be the actual range
+ # that was cleared, bounded to the sheet's limits.)
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(spreadsheetId, range, valueRenderOption=None, majorDimension=None, dateTimeRenderOption=None, x__xgafv=None)</code>
<pre>Returns a range of values from a spreadsheet.
The caller must specify the spreadsheet ID and a range.
diff --git a/docs/dyn/sqladmin_v1beta3.backupRuns.html b/docs/dyn/sqladmin_v1beta3.backupRuns.html
index 093479f..995235e 100644
--- a/docs/dyn/sqladmin_v1beta3.backupRuns.html
+++ b/docs/dyn/sqladmin_v1beta3.backupRuns.html
@@ -92,7 +92,7 @@
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
backupConfiguration: string, Identifier for the backup configuration. This gets generated automatically when a backup configuration is created. (required)
- dueTime: string, The time when this run is due to start in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. (required)
+ dueTime: string, The start time of the four-hour backup window. The backup can occur any time in the window. The time is in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. (required)
Returns:
An object of the form:
diff --git a/docs/dyn/sqladmin_v1beta3.html b/docs/dyn/sqladmin_v1beta3.html
index 6d997af..487a694 100644
--- a/docs/dyn/sqladmin_v1beta3.html
+++ b/docs/dyn/sqladmin_v1beta3.html
@@ -104,4 +104,25 @@
</p>
<p class="firstline">Returns the tiers Resource.</p>
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/sqladmin_v1beta3.instances.html b/docs/dyn/sqladmin_v1beta3.instances.html
index b69db8f..1d1c609 100644
--- a/docs/dyn/sqladmin_v1beta3.instances.html
+++ b/docs/dyn/sqladmin_v1beta3.instances.html
@@ -217,6 +217,7 @@
"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"kind": "sql#instance", # This is always sql#instance.
"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "ipv6Address": "A String", # The IPv6 address assigned to the instance.
"serverCaCert": { # SslCerts Resource # SSL configuration.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
@@ -230,12 +231,12 @@
"replicaNames": [ # The replicas of the instance.
"A String",
],
- "region": "A String", # The geographical region. Can be us-east1, us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
+ "region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
"settings": { # Database instance settings. # The user settings.
"databaseFlags": [ # The database flags passed to the instance at startup.
{ # MySQL flags for Cloud SQL instances.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: character_set_server utf8 or utf8mb4 event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off. If set to on, you must also set the log_output flag to TABLE to receive logs. wait_timeout 1..31536000
- "value": "A String", # The value of the flag. Booleans should be set using 1 for true, and 0 for false. This field must be omitted if the flag doesn't take a value.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
+ "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
},
],
"kind": "sql#settings", # This is always sql#settings.
@@ -257,6 +258,7 @@
],
"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
"enabled": True or False, # Whether the instance should be assigned an IP address or not.
+ "kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
"requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
"A String",
@@ -283,12 +285,14 @@
# MAINTENANCE: The instance is down for maintenance.
# UNKNOWN_STATE: The state of the instance is unknown.
"etag": "A String", # HTTP 1.1 Entity tag for the resource.
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
"ipAddresses": [ # The assigned IP addresses for the instance.
{ # Database instance IP Mapping.
"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
"ipAddress": "A String", # The IP address assigned.
},
],
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
"databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
"instanceType": "A String", # The instance type. This can be one of the following.
# CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
@@ -339,6 +343,7 @@
"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"kind": "sql#instance", # This is always sql#instance.
"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "ipv6Address": "A String", # The IPv6 address assigned to the instance.
"serverCaCert": { # SslCerts Resource # SSL configuration.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
@@ -352,12 +357,12 @@
"replicaNames": [ # The replicas of the instance.
"A String",
],
- "region": "A String", # The geographical region. Can be us-east1, us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
+ "region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
"settings": { # Database instance settings. # The user settings.
"databaseFlags": [ # The database flags passed to the instance at startup.
{ # MySQL flags for Cloud SQL instances.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: character_set_server utf8 or utf8mb4 event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off. If set to on, you must also set the log_output flag to TABLE to receive logs. wait_timeout 1..31536000
- "value": "A String", # The value of the flag. Booleans should be set using 1 for true, and 0 for false. This field must be omitted if the flag doesn't take a value.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
+ "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
},
],
"kind": "sql#settings", # This is always sql#settings.
@@ -379,6 +384,7 @@
],
"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
"enabled": True or False, # Whether the instance should be assigned an IP address or not.
+ "kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
"requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
"A String",
@@ -405,12 +411,14 @@
# MAINTENANCE: The instance is down for maintenance.
# UNKNOWN_STATE: The state of the instance is unknown.
"etag": "A String", # HTTP 1.1 Entity tag for the resource.
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
"ipAddresses": [ # The assigned IP addresses for the instance.
{ # Database instance IP Mapping.
"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
"ipAddress": "A String", # The IP address assigned.
},
],
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
"databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
"instanceType": "A String", # The instance type. This can be one of the following.
# CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
@@ -446,6 +454,7 @@
"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"kind": "sql#instance", # This is always sql#instance.
"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "ipv6Address": "A String", # The IPv6 address assigned to the instance.
"serverCaCert": { # SslCerts Resource # SSL configuration.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
@@ -459,12 +468,12 @@
"replicaNames": [ # The replicas of the instance.
"A String",
],
- "region": "A String", # The geographical region. Can be us-east1, us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
+ "region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
"settings": { # Database instance settings. # The user settings.
"databaseFlags": [ # The database flags passed to the instance at startup.
{ # MySQL flags for Cloud SQL instances.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: character_set_server utf8 or utf8mb4 event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off. If set to on, you must also set the log_output flag to TABLE to receive logs. wait_timeout 1..31536000
- "value": "A String", # The value of the flag. Booleans should be set using 1 for true, and 0 for false. This field must be omitted if the flag doesn't take a value.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
+ "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
},
],
"kind": "sql#settings", # This is always sql#settings.
@@ -486,6 +495,7 @@
],
"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
"enabled": True or False, # Whether the instance should be assigned an IP address or not.
+ "kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
"requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
"A String",
@@ -512,12 +522,14 @@
# MAINTENANCE: The instance is down for maintenance.
# UNKNOWN_STATE: The state of the instance is unknown.
"etag": "A String", # HTTP 1.1 Entity tag for the resource.
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
"ipAddresses": [ # The assigned IP addresses for the instance.
{ # Database instance IP Mapping.
"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
"ipAddress": "A String", # The IP address assigned.
},
],
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
"databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
"instanceType": "A String", # The instance type. This can be one of the following.
# CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
@@ -556,6 +568,7 @@
"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"kind": "sql#instance", # This is always sql#instance.
"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "ipv6Address": "A String", # The IPv6 address assigned to the instance.
"serverCaCert": { # SslCerts Resource # SSL configuration.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
@@ -569,12 +582,12 @@
"replicaNames": [ # The replicas of the instance.
"A String",
],
- "region": "A String", # The geographical region. Can be us-east1, us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
+ "region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
"settings": { # Database instance settings. # The user settings.
"databaseFlags": [ # The database flags passed to the instance at startup.
{ # MySQL flags for Cloud SQL instances.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: character_set_server utf8 or utf8mb4 event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off. If set to on, you must also set the log_output flag to TABLE to receive logs. wait_timeout 1..31536000
- "value": "A String", # The value of the flag. Booleans should be set using 1 for true, and 0 for false. This field must be omitted if the flag doesn't take a value.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
+ "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
},
],
"kind": "sql#settings", # This is always sql#settings.
@@ -596,6 +609,7 @@
],
"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
"enabled": True or False, # Whether the instance should be assigned an IP address or not.
+ "kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
"requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
"A String",
@@ -622,12 +636,14 @@
# MAINTENANCE: The instance is down for maintenance.
# UNKNOWN_STATE: The state of the instance is unknown.
"etag": "A String", # HTTP 1.1 Entity tag for the resource.
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
"ipAddresses": [ # The assigned IP addresses for the instance.
{ # Database instance IP Mapping.
"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
"ipAddress": "A String", # The IP address assigned.
},
],
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
"databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
"instanceType": "A String", # The instance type. This can be one of the following.
# CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
@@ -703,7 +719,7 @@
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
backupConfiguration: string, The identifier of the backup configuration. This gets generated automatically when a backup configuration is created. (required)
- dueTime: string, The time when this run is due to start in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. (required)
+ dueTime: string, The start time of the four-hour backup window. The backup can occur any time in the window. The time is in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. (required)
Returns:
An object of the form:
@@ -755,6 +771,7 @@
"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"kind": "sql#instance", # This is always sql#instance.
"maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "ipv6Address": "A String", # The IPv6 address assigned to the instance.
"serverCaCert": { # SslCerts Resource # SSL configuration.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
@@ -768,12 +785,12 @@
"replicaNames": [ # The replicas of the instance.
"A String",
],
- "region": "A String", # The geographical region. Can be us-east1, us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
+ "region": "A String", # The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.
"settings": { # Database instance settings. # The user settings.
"databaseFlags": [ # The database flags passed to the instance at startup.
{ # MySQL flags for Cloud SQL instances.
- "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. Refer to the official MySQL documentation on server options and system variables for descriptions of what these flags do. Acceptable values are: character_set_server utf8 or utf8mb4 event_scheduler on or off (Note: The event scheduler will only work reliably if the instance activationPolicy is set to ALWAYS) general_log on or off group_concat_max_len 4..17179869184 innodb_flush_log_at_trx_commit 0..2 innodb_lock_wait_timeout 1..1073741824 log_bin_trust_function_creators on or off log_output Can be either TABLE or NONE, FILE is not supported log_queries_not_using_indexes on or off long_query_time 0..30000000 lower_case_table_names 0..2 max_allowed_packet 16384..1073741824 read_only on or off skip_show_database on or off slow_query_log on or off. If set to on, you must also set the log_output flag to TABLE to receive logs. wait_timeout 1..31536000
- "value": "A String", # The value of the flag. Booleans should be set using 1 for true, and 0 for false. This field must be omitted if the flag doesn't take a value.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.
+ "value": "A String", # The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
},
],
"kind": "sql#settings", # This is always sql#settings.
@@ -795,6 +812,7 @@
],
"ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.
"enabled": True or False, # Whether the instance should be assigned an IP address or not.
+ "kind": "sql#ipConfiguration", # This is always sql#ipConfiguration.
"requireSsl": True or False, # Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.
"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
"A String",
@@ -821,12 +839,14 @@
# MAINTENANCE: The instance is down for maintenance.
# UNKNOWN_STATE: The state of the instance is unknown.
"etag": "A String", # HTTP 1.1 Entity tag for the resource.
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.
"ipAddresses": [ # The assigned IP addresses for the instance.
{ # Database instance IP Mapping.
"timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
"ipAddress": "A String", # The IP address assigned.
},
],
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
"databaseVersion": "A String", # The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion cannot be changed after instance creation.
"instanceType": "A String", # The instance type. This can be one of the following.
# CLOUD_SQL_INSTANCE: Regular Cloud SQL instance.
diff --git a/docs/dyn/storage_v1.buckets.html b/docs/dyn/storage_v1.buckets.html
index ae93d11..ccb8de0 100644
--- a/docs/dyn/storage_v1.buckets.html
+++ b/docs/dyn/storage_v1.buckets.html
@@ -225,12 +225,16 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action. Currently, only Delete is supported.
+ "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported.
+ "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
+ "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
+ "A String",
+ ],
"age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
+ "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
"createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
},
},
@@ -238,7 +242,7 @@
},
"id": "A String", # The ID of the bucket.
"projectNumber": "A String", # The project number of the project the bucket belongs to.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
+ "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
}</pre>
</div>
@@ -353,12 +357,16 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action. Currently, only Delete is supported.
+ "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported.
+ "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
+ "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
+ "A String",
+ ],
"age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
+ "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
"createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
},
},
@@ -366,7 +374,7 @@
},
"id": "A String", # The ID of the bucket.
"projectNumber": "A String", # The project number of the project the bucket belongs to.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
+ "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
}
projection: string, Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
@@ -494,12 +502,16 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action. Currently, only Delete is supported.
+ "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported.
+ "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
+ "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
+ "A String",
+ ],
"age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
+ "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
"createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
},
},
@@ -507,7 +519,7 @@
},
"id": "A String", # The ID of the bucket.
"projectNumber": "A String", # The project number of the project the bucket belongs to.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
+ "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
}</pre>
</div>
@@ -633,12 +645,16 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action. Currently, only Delete is supported.
+ "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported.
+ "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
+ "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
+ "A String",
+ ],
"age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
+ "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
"createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
},
},
@@ -646,7 +662,7 @@
},
"id": "A String", # The ID of the bucket.
"projectNumber": "A String", # The project number of the project the bucket belongs to.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
+ "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
},
],
"kind": "storage#buckets", # The kind of item this is. For lists of buckets, this is always storage#buckets.
@@ -778,12 +794,16 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action. Currently, only Delete is supported.
+ "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported.
+ "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
+ "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
+ "A String",
+ ],
"age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
+ "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
"createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
},
},
@@ -791,7 +811,7 @@
},
"id": "A String", # The ID of the bucket.
"projectNumber": "A String", # The project number of the project the bucket belongs to.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
+ "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
}
projection: string, Set of properties to return. Defaults to full.
@@ -921,12 +941,16 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action. Currently, only Delete is supported.
+ "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported.
+ "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
+ "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
+ "A String",
+ ],
"age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
+ "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
"createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
},
},
@@ -934,7 +958,7 @@
},
"id": "A String", # The ID of the bucket.
"projectNumber": "A String", # The project number of the project the bucket belongs to.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
+ "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
}</pre>
</div>
@@ -1049,12 +1073,16 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action. Currently, only Delete is supported.
+ "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported.
+ "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
+ "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
+ "A String",
+ ],
"age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
+ "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
"createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
},
},
@@ -1062,7 +1090,7 @@
},
"id": "A String", # The ID of the bucket.
"projectNumber": "A String", # The project number of the project the bucket belongs to.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
+ "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
}
projection: string, Set of properties to return. Defaults to full.
@@ -1192,12 +1220,16 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action. Currently, only Delete is supported.
+ "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported.
+ "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
+ "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
+ "A String",
+ ],
"age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
+ "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
"createdBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
},
},
@@ -1205,7 +1237,7 @@
},
"id": "A String", # The ID of the bucket.
"projectNumber": "A String", # The project number of the project the bucket belongs to.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include STANDARD, NEARLINE and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. For more information, see storage classes.
+ "storageClass": "A String", # The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
}</pre>
</div>
diff --git a/docs/dyn/storage_v1beta1.bucketAccessControls.html b/docs/dyn/storage_v1beta1.bucketAccessControls.html
new file mode 100644
index 0000000..c288d1b
--- /dev/null
+++ b/docs/dyn/storage_v1beta1.bucketAccessControls.html
@@ -0,0 +1,354 @@
+<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="storage_v1beta1.html">Cloud Storage JSON API</a> . <a href="storage_v1beta1.bucketAccessControls.html">bucketAccessControls</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(bucket, entity)</a></code></p>
+<p class="firstline">Deletes the ACL entry for the specified entity on the specified bucket.</p>
+<p class="toc_element">
+ <code><a href="#get">get(bucket, entity)</a></code></p>
+<p class="firstline">Returns the ACL entry for the specified entity on the specified bucket.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(bucket, body)</a></code></p>
+<p class="firstline">Creates a new ACL entry on the specified bucket.</p>
+<p class="toc_element">
+ <code><a href="#list">list(bucket)</a></code></p>
+<p class="firstline">Retrieves ACL entries on the specified bucket.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(bucket, entity, body)</a></code></p>
+<p class="firstline">Updates an ACL entry on the specified bucket. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(bucket, entity, body)</a></code></p>
+<p class="firstline">Updates an ACL entry on the specified bucket.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(bucket, entity)</code>
+ <pre>Deletes the ACL entry for the specified entity on the specified bucket.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(bucket, entity)</code>
+ <pre>Returns the ACL entry for the specified entity on the specified bucket.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
+
+Returns:
+ An object of the form:
+
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(bucket, body)</code>
+ <pre>Creates a new ACL entry on the specified bucket.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(bucket)</code>
+ <pre>Retrieves ACL entries on the specified bucket.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+
+Returns:
+ An object of the form:
+
+ { # An access-control list.
+ "items": [ # The list of items.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "kind": "storage#bucketAccessControls", # The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(bucket, entity, body)</code>
+ <pre>Updates an ACL entry on the specified bucket. This method supports patch semantics.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(bucket, entity, body)</code>
+ <pre>Updates an ACL entry on the specified bucket.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/storage_v1beta1.buckets.html b/docs/dyn/storage_v1beta1.buckets.html
new file mode 100644
index 0000000..fa103ee
--- /dev/null
+++ b/docs/dyn/storage_v1beta1.buckets.html
@@ -0,0 +1,725 @@
+<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="storage_v1beta1.html">Cloud Storage JSON API</a> . <a href="storage_v1beta1.buckets.html">buckets</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(bucket)</a></code></p>
+<p class="firstline">Deletes an empty bucket.</p>
+<p class="toc_element">
+ <code><a href="#get">get(bucket, projection=None)</a></code></p>
+<p class="firstline">Returns metadata for the specified bucket.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(body, projection=None)</a></code></p>
+<p class="firstline">Creates a new bucket.</p>
+<p class="toc_element">
+ <code><a href="#list">list(projectId, projection=None, pageToken=None, max_results=None)</a></code></p>
+<p class="firstline">Retrieves a list of buckets for a given 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(bucket, body, projection=None)</a></code></p>
+<p class="firstline">Updates a bucket. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(bucket, body, projection=None)</a></code></p>
+<p class="firstline">Updates a bucket.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(bucket)</code>
+ <pre>Deletes an empty bucket.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(bucket, projection=None)</code>
+ <pre>Returns metadata for the specified bucket.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ projection: string, Set of properties to return. Defaults to no_acl.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit acl and defaultObjectAcl properties.
+
+Returns:
+ An object of the form:
+
+ { # A bucket.
+ "website": { # The bucket's website configuration.
+ "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
+ "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
+ },
+ "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
+ "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
+ "projectId": "A String", # The project the bucket belongs to.
+ "acl": [ # Access controls on the bucket.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
+ "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form group-groupId.
+ },
+ "id": "A String", # The name of the bucket.
+ "selfLink": "A String", # The URI of this bucket.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(body, projection=None)</code>
+ <pre>Creates a new bucket.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A bucket.
+ "website": { # The bucket's website configuration.
+ "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
+ "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
+ },
+ "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
+ "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
+ "projectId": "A String", # The project the bucket belongs to.
+ "acl": [ # Access controls on the bucket.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
+ "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form group-groupId.
+ },
+ "id": "A String", # The name of the bucket.
+ "selfLink": "A String", # The URI of this bucket.
+ }
+
+ projection: string, Set of properties to return. Defaults to no_acl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit acl and defaultObjectAcl properties.
+
+Returns:
+ An object of the form:
+
+ { # A bucket.
+ "website": { # The bucket's website configuration.
+ "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
+ "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
+ },
+ "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
+ "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
+ "projectId": "A String", # The project the bucket belongs to.
+ "acl": [ # Access controls on the bucket.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
+ "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form group-groupId.
+ },
+ "id": "A String", # The name of the bucket.
+ "selfLink": "A String", # The URI of this bucket.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(projectId, projection=None, pageToken=None, max_results=None)</code>
+ <pre>Retrieves a list of buckets for a given project.
+
+Args:
+ projectId: string, A valid API project identifier. (required)
+ projection: string, Set of properties to return. Defaults to no_acl.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit acl and defaultObjectAcl properties.
+ pageToken: string, A previously-returned page token representing part of the larger set of results to view.
+ max_results: integer, Maximum number of buckets to return.
+
+Returns:
+ An object of the form:
+
+ { # A list of buckets.
+ "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "items": [ # The list of items.
+ { # A bucket.
+ "website": { # The bucket's website configuration.
+ "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
+ "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
+ },
+ "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
+ "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
+ "projectId": "A String", # The project the bucket belongs to.
+ "acl": [ # Access controls on the bucket.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
+ "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form group-groupId.
+ },
+ "id": "A String", # The name of the bucket.
+ "selfLink": "A String", # The URI of this bucket.
+ },
+ ],
+ "kind": "storage#buckets", # The kind of item this is. For lists of buckets, this is always storage#buckets.
+ }</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(bucket, body, projection=None)</code>
+ <pre>Updates a bucket. This method supports patch semantics.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A bucket.
+ "website": { # The bucket's website configuration.
+ "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
+ "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
+ },
+ "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
+ "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
+ "projectId": "A String", # The project the bucket belongs to.
+ "acl": [ # Access controls on the bucket.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
+ "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form group-groupId.
+ },
+ "id": "A String", # The name of the bucket.
+ "selfLink": "A String", # The URI of this bucket.
+ }
+
+ projection: string, Set of properties to return. Defaults to full.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit acl and defaultObjectAcl properties.
+
+Returns:
+ An object of the form:
+
+ { # A bucket.
+ "website": { # The bucket's website configuration.
+ "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
+ "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
+ },
+ "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
+ "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
+ "projectId": "A String", # The project the bucket belongs to.
+ "acl": [ # Access controls on the bucket.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
+ "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form group-groupId.
+ },
+ "id": "A String", # The name of the bucket.
+ "selfLink": "A String", # The URI of this bucket.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(bucket, body, projection=None)</code>
+ <pre>Updates a bucket.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A bucket.
+ "website": { # The bucket's website configuration.
+ "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
+ "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
+ },
+ "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
+ "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
+ "projectId": "A String", # The project the bucket belongs to.
+ "acl": [ # Access controls on the bucket.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
+ "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form group-groupId.
+ },
+ "id": "A String", # The name of the bucket.
+ "selfLink": "A String", # The URI of this bucket.
+ }
+
+ projection: string, Set of properties to return. Defaults to full.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit acl and defaultObjectAcl properties.
+
+Returns:
+ An object of the form:
+
+ { # A bucket.
+ "website": { # The bucket's website configuration.
+ "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
+ "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
+ },
+ "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
+ "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
+ "projectId": "A String", # The project the bucket belongs to.
+ "acl": [ # Access controls on the bucket.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
+ "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form group-groupId.
+ },
+ "id": "A String", # The name of the bucket.
+ "selfLink": "A String", # The URI of this bucket.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/computeaccounts_alpha.html b/docs/dyn/storage_v1beta1.html
similarity index 76%
copy from docs/dyn/computeaccounts_alpha.html
copy to docs/dyn/storage_v1beta1.html
index 938942e..ae72c80 100644
--- a/docs/dyn/computeaccounts_alpha.html
+++ b/docs/dyn/storage_v1beta1.html
@@ -72,27 +72,27 @@
</style>
-<h1><a href="computeaccounts_alpha.html">Compute Accounts API</a></h1>
+<h1><a href="storage_v1beta1.html">Cloud Storage JSON API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.globalAccountsOperations.html">globalAccountsOperations()</a></code>
+ <code><a href="storage_v1beta1.bucketAccessControls.html">bucketAccessControls()</a></code>
</p>
-<p class="firstline">Returns the globalAccountsOperations Resource.</p>
+<p class="firstline">Returns the bucketAccessControls Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.groups.html">groups()</a></code>
+ <code><a href="storage_v1beta1.buckets.html">buckets()</a></code>
</p>
-<p class="firstline">Returns the groups Resource.</p>
+<p class="firstline">Returns the buckets Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.linux.html">linux()</a></code>
+ <code><a href="storage_v1beta1.objectAccessControls.html">objectAccessControls()</a></code>
</p>
-<p class="firstline">Returns the linux Resource.</p>
+<p class="firstline">Returns the objectAccessControls Resource.</p>
<p class="toc_element">
- <code><a href="computeaccounts_alpha.users.html">users()</a></code>
+ <code><a href="storage_v1beta1.objects.html">objects()</a></code>
</p>
-<p class="firstline">Returns the users Resource.</p>
+<p class="firstline">Returns the objects Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/storage_v1beta1.objectAccessControls.html b/docs/dyn/storage_v1beta1.objectAccessControls.html
new file mode 100644
index 0000000..4359855
--- /dev/null
+++ b/docs/dyn/storage_v1beta1.objectAccessControls.html
@@ -0,0 +1,368 @@
+<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="storage_v1beta1.html">Cloud Storage JSON API</a> . <a href="storage_v1beta1.objectAccessControls.html">objectAccessControls</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(bucket, object, entity)</a></code></p>
+<p class="firstline">Deletes the ACL entry for the specified entity on the specified object.</p>
+<p class="toc_element">
+ <code><a href="#get">get(bucket, object, entity)</a></code></p>
+<p class="firstline">Returns the ACL entry for the specified entity on the specified object.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(bucket, object, body)</a></code></p>
+<p class="firstline">Creates a new ACL entry on the specified object.</p>
+<p class="toc_element">
+ <code><a href="#list">list(bucket, object)</a></code></p>
+<p class="firstline">Retrieves ACL entries on the specified object.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(bucket, object, entity, body)</a></code></p>
+<p class="firstline">Updates an ACL entry on the specified object. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(bucket, object, entity, body)</a></code></p>
+<p class="firstline">Updates an ACL entry on the specified object.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(bucket, object, entity)</code>
+ <pre>Deletes the ACL entry for the specified entity on the specified object.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ object: string, Name of the object. (required)
+ entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(bucket, object, entity)</code>
+ <pre>Returns the ACL entry for the specified entity on the specified object.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ object: string, Name of the object. (required)
+ entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
+
+Returns:
+ An object of the form:
+
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(bucket, object, body)</code>
+ <pre>Creates a new ACL entry on the specified object.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ object: string, Name of the object. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(bucket, object)</code>
+ <pre>Retrieves ACL entries on the specified object.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ object: string, Name of the object. (required)
+
+Returns:
+ An object of the form:
+
+ { # An access-control list.
+ "items": [ # The list of items.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(bucket, object, entity, body)</code>
+ <pre>Updates an ACL entry on the specified object. This method supports patch semantics.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ object: string, Name of the object. (required)
+ entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(bucket, object, entity, body)</code>
+ <pre>Updates an ACL entry on the specified object.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ object: string, Name of the object. (required)
+ entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/storage_v1beta1.objects.html b/docs/dyn/storage_v1beta1.objects.html
new file mode 100644
index 0000000..c80a39a
--- /dev/null
+++ b/docs/dyn/storage_v1beta1.objects.html
@@ -0,0 +1,815 @@
+<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="storage_v1beta1.html">Cloud Storage JSON API</a> . <a href="storage_v1beta1.objects.html">objects</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(bucket, object)</a></code></p>
+<p class="firstline">Deletes data blobs and associated metadata.</p>
+<p class="toc_element">
+ <code><a href="#get">get(bucket, object, projection=None)</a></code></p>
+<p class="firstline">Retrieves objects or their associated metadata.</p>
+<p class="toc_element">
+ <code><a href="#get_media">get_media(bucket, object, projection=None)</a></code></p>
+<p class="firstline">Retrieves objects or their associated metadata.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(bucket, body=None, media_body=None, name=None, projection=None)</a></code></p>
+<p class="firstline">Stores new data blobs and associated metadata.</p>
+<p class="toc_element">
+ <code><a href="#insert_media">insert_media(bucket, body=None, media_body=None, name=None, projection=None)</a></code></p>
+<p class="firstline">Stores new data blobs and associated metadata.</p>
+<p class="toc_element">
+ <code><a href="#list">list(bucket, projection=None, pageToken=None, delimiter=None, prefix=None, max_results=None)</a></code></p>
+<p class="firstline">Retrieves a list of objects matching the criteria.</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(bucket, object, body, projection=None)</a></code></p>
+<p class="firstline">Updates a data blob's associated metadata. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(bucket, object, body, projection=None)</a></code></p>
+<p class="firstline">Updates a data blob's associated metadata.</p>
+<p class="toc_element">
+ <code><a href="#update_media">update_media(bucket, object, body, projection=None)</a></code></p>
+<p class="firstline">Updates a data blob's associated metadata.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(bucket, object)</code>
+ <pre>Deletes data blobs and associated metadata.
+
+Args:
+ bucket: string, Name of the bucket in which the object resides. (required)
+ object: string, Name of the object. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(bucket, object, projection=None)</code>
+ <pre>Retrieves objects or their associated metadata.
+
+Args:
+ bucket: string, Name of the bucket in which the object resides. (required)
+ object: string, Name of the object. (required)
+ projection: string, Set of properties to return. Defaults to no_acl.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit the acl property.
+
+Returns:
+ An object of the form:
+
+ { # An object.
+ "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
+ "name": "A String", # The name of this object. Required if not specified by URL parameter.
+ "contentLanguage": "A String", # Content-Language of the object data.
+ "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
+ "contentType": "A String", # Content-Type of the object data.
+ "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
+ "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
+ "length": "A String", # Content-Length of the data in bytes.
+ "link": "A String", # Media download link.
+ "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
+ "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
+ },
+ "bucket": "A String", # The bucket containing this object.
+ "contentEncoding": "A String", # Content-Encoding of the object data.
+ "selfLink": "A String", # The link to this object.
+ "owner": { # The owner of the object. This will always be the uploader of the object.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form user-userId.
+ },
+ "cacheControl": "A String", # Cache-Control directive for the object data.
+ "acl": [ # Access controls on the object.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "id": "A String", # The ID of the object.
+ "contentDisposition": "A String", # Content-Disposition of the object data.
+ "metadata": { # User-provided metadata, in key/value pairs.
+ "a_key": "A String", # An individual metadata entry.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get_media">get_media(bucket, object, projection=None)</code>
+ <pre>Retrieves objects or their associated metadata.
+
+Args:
+ bucket: string, Name of the bucket in which the object resides. (required)
+ object: string, Name of the object. (required)
+ projection: string, Set of properties to return. Defaults to no_acl.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit the acl property.
+
+Returns:
+ The media object as a string.
+
+ </pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(bucket, body=None, media_body=None, name=None, projection=None)</code>
+ <pre>Stores new data blobs and associated metadata.
+
+Args:
+ bucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An object.
+ "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
+ "name": "A String", # The name of this object. Required if not specified by URL parameter.
+ "contentLanguage": "A String", # Content-Language of the object data.
+ "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
+ "contentType": "A String", # Content-Type of the object data.
+ "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
+ "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
+ "length": "A String", # Content-Length of the data in bytes.
+ "link": "A String", # Media download link.
+ "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
+ "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
+ },
+ "bucket": "A String", # The bucket containing this object.
+ "contentEncoding": "A String", # Content-Encoding of the object data.
+ "selfLink": "A String", # The link to this object.
+ "owner": { # The owner of the object. This will always be the uploader of the object.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form user-userId.
+ },
+ "cacheControl": "A String", # Cache-Control directive for the object data.
+ "acl": [ # Access controls on the object.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "id": "A String", # The ID of the object.
+ "contentDisposition": "A String", # Content-Disposition of the object data.
+ "metadata": { # User-provided metadata, in key/value pairs.
+ "a_key": "A String", # An individual metadata entry.
+ },
+ }
+
+ media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+ name: string, Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.
+ projection: string, Set of properties to return. Defaults to no_acl, unless the object resource specifies the acl property, when it defaults to full.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit the acl property.
+
+Returns:
+ An object of the form:
+
+ { # An object.
+ "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
+ "name": "A String", # The name of this object. Required if not specified by URL parameter.
+ "contentLanguage": "A String", # Content-Language of the object data.
+ "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
+ "contentType": "A String", # Content-Type of the object data.
+ "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
+ "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
+ "length": "A String", # Content-Length of the data in bytes.
+ "link": "A String", # Media download link.
+ "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
+ "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
+ },
+ "bucket": "A String", # The bucket containing this object.
+ "contentEncoding": "A String", # Content-Encoding of the object data.
+ "selfLink": "A String", # The link to this object.
+ "owner": { # The owner of the object. This will always be the uploader of the object.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form user-userId.
+ },
+ "cacheControl": "A String", # Cache-Control directive for the object data.
+ "acl": [ # Access controls on the object.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "id": "A String", # The ID of the object.
+ "contentDisposition": "A String", # Content-Disposition of the object data.
+ "metadata": { # User-provided metadata, in key/value pairs.
+ "a_key": "A String", # An individual metadata entry.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert_media">insert_media(bucket, body=None, media_body=None, name=None, projection=None)</code>
+ <pre>Stores new data blobs and associated metadata.
+
+Args:
+ bucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An object.
+ "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
+ "name": "A String", # The name of this object. Required if not specified by URL parameter.
+ "contentLanguage": "A String", # Content-Language of the object data.
+ "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
+ "contentType": "A String", # Content-Type of the object data.
+ "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
+ "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
+ "length": "A String", # Content-Length of the data in bytes.
+ "link": "A String", # Media download link.
+ "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
+ "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
+ },
+ "bucket": "A String", # The bucket containing this object.
+ "contentEncoding": "A String", # Content-Encoding of the object data.
+ "selfLink": "A String", # The link to this object.
+ "owner": { # The owner of the object. This will always be the uploader of the object.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form user-userId.
+ },
+ "cacheControl": "A String", # Cache-Control directive for the object data.
+ "acl": [ # Access controls on the object.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "id": "A String", # The ID of the object.
+ "contentDisposition": "A String", # Content-Disposition of the object data.
+ "metadata": { # User-provided metadata, in key/value pairs.
+ "a_key": "A String", # An individual metadata entry.
+ },
+ }
+
+ media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+ name: string, Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.
+ projection: string, Set of properties to return. Defaults to no_acl, unless the object resource specifies the acl property, when it defaults to full.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit the acl property.
+
+Returns:
+ The media object as a string.
+
+ </pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(bucket, projection=None, pageToken=None, delimiter=None, prefix=None, max_results=None)</code>
+ <pre>Retrieves a list of objects matching the criteria.
+
+Args:
+ bucket: string, Name of the bucket in which to look for objects. (required)
+ projection: string, Set of properties to return. Defaults to no_acl.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit the acl property.
+ pageToken: string, A previously-returned page token representing part of the larger set of results to view.
+ delimiter: string, Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
+ prefix: string, Filter results to objects whose names begin with this prefix.
+ max_results: integer, Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested.
+
+Returns:
+ An object of the form:
+
+ { # A list of objects.
+ "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "items": [ # The list of items.
+ { # An object.
+ "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
+ "name": "A String", # The name of this object. Required if not specified by URL parameter.
+ "contentLanguage": "A String", # Content-Language of the object data.
+ "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
+ "contentType": "A String", # Content-Type of the object data.
+ "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
+ "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
+ "length": "A String", # Content-Length of the data in bytes.
+ "link": "A String", # Media download link.
+ "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
+ "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
+ },
+ "bucket": "A String", # The bucket containing this object.
+ "contentEncoding": "A String", # Content-Encoding of the object data.
+ "selfLink": "A String", # The link to this object.
+ "owner": { # The owner of the object. This will always be the uploader of the object.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form user-userId.
+ },
+ "cacheControl": "A String", # Cache-Control directive for the object data.
+ "acl": [ # Access controls on the object.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "id": "A String", # The ID of the object.
+ "contentDisposition": "A String", # Content-Disposition of the object data.
+ "metadata": { # User-provided metadata, in key/value pairs.
+ "a_key": "A String", # An individual metadata entry.
+ },
+ },
+ ],
+ "kind": "storage#objects", # The kind of item this is. For lists of objects, this is always storage#objects.
+ "prefixes": [ # The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter.
+ "A String",
+ ],
+ }</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(bucket, object, body, projection=None)</code>
+ <pre>Updates a data blob's associated metadata. This method supports patch semantics.
+
+Args:
+ bucket: string, Name of the bucket in which the object resides. (required)
+ object: string, Name of the object. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An object.
+ "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
+ "name": "A String", # The name of this object. Required if not specified by URL parameter.
+ "contentLanguage": "A String", # Content-Language of the object data.
+ "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
+ "contentType": "A String", # Content-Type of the object data.
+ "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
+ "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
+ "length": "A String", # Content-Length of the data in bytes.
+ "link": "A String", # Media download link.
+ "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
+ "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
+ },
+ "bucket": "A String", # The bucket containing this object.
+ "contentEncoding": "A String", # Content-Encoding of the object data.
+ "selfLink": "A String", # The link to this object.
+ "owner": { # The owner of the object. This will always be the uploader of the object.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form user-userId.
+ },
+ "cacheControl": "A String", # Cache-Control directive for the object data.
+ "acl": [ # Access controls on the object.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "id": "A String", # The ID of the object.
+ "contentDisposition": "A String", # Content-Disposition of the object data.
+ "metadata": { # User-provided metadata, in key/value pairs.
+ "a_key": "A String", # An individual metadata entry.
+ },
+ }
+
+ projection: string, Set of properties to return. Defaults to full.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit the acl property.
+
+Returns:
+ An object of the form:
+
+ { # An object.
+ "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
+ "name": "A String", # The name of this object. Required if not specified by URL parameter.
+ "contentLanguage": "A String", # Content-Language of the object data.
+ "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
+ "contentType": "A String", # Content-Type of the object data.
+ "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
+ "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
+ "length": "A String", # Content-Length of the data in bytes.
+ "link": "A String", # Media download link.
+ "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
+ "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
+ },
+ "bucket": "A String", # The bucket containing this object.
+ "contentEncoding": "A String", # Content-Encoding of the object data.
+ "selfLink": "A String", # The link to this object.
+ "owner": { # The owner of the object. This will always be the uploader of the object.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form user-userId.
+ },
+ "cacheControl": "A String", # Cache-Control directive for the object data.
+ "acl": [ # Access controls on the object.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "id": "A String", # The ID of the object.
+ "contentDisposition": "A String", # Content-Disposition of the object data.
+ "metadata": { # User-provided metadata, in key/value pairs.
+ "a_key": "A String", # An individual metadata entry.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(bucket, object, body, projection=None)</code>
+ <pre>Updates a data blob's associated metadata.
+
+Args:
+ bucket: string, Name of the bucket in which the object resides. (required)
+ object: string, Name of the object. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An object.
+ "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
+ "name": "A String", # The name of this object. Required if not specified by URL parameter.
+ "contentLanguage": "A String", # Content-Language of the object data.
+ "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
+ "contentType": "A String", # Content-Type of the object data.
+ "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
+ "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
+ "length": "A String", # Content-Length of the data in bytes.
+ "link": "A String", # Media download link.
+ "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
+ "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
+ },
+ "bucket": "A String", # The bucket containing this object.
+ "contentEncoding": "A String", # Content-Encoding of the object data.
+ "selfLink": "A String", # The link to this object.
+ "owner": { # The owner of the object. This will always be the uploader of the object.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form user-userId.
+ },
+ "cacheControl": "A String", # Cache-Control directive for the object data.
+ "acl": [ # Access controls on the object.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "id": "A String", # The ID of the object.
+ "contentDisposition": "A String", # Content-Disposition of the object data.
+ "metadata": { # User-provided metadata, in key/value pairs.
+ "a_key": "A String", # An individual metadata entry.
+ },
+ }
+
+ projection: string, Set of properties to return. Defaults to full.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit the acl property.
+
+Returns:
+ An object of the form:
+
+ { # An object.
+ "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
+ "name": "A String", # The name of this object. Required if not specified by URL parameter.
+ "contentLanguage": "A String", # Content-Language of the object data.
+ "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
+ "contentType": "A String", # Content-Type of the object data.
+ "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
+ "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
+ "length": "A String", # Content-Length of the data in bytes.
+ "link": "A String", # Media download link.
+ "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
+ "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
+ },
+ "bucket": "A String", # The bucket containing this object.
+ "contentEncoding": "A String", # Content-Encoding of the object data.
+ "selfLink": "A String", # The link to this object.
+ "owner": { # The owner of the object. This will always be the uploader of the object.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form user-userId.
+ },
+ "cacheControl": "A String", # Cache-Control directive for the object data.
+ "acl": [ # Access controls on the object.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "id": "A String", # The ID of the object.
+ "contentDisposition": "A String", # Content-Disposition of the object data.
+ "metadata": { # User-provided metadata, in key/value pairs.
+ "a_key": "A String", # An individual metadata entry.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update_media">update_media(bucket, object, body, projection=None)</code>
+ <pre>Updates a data blob's associated metadata.
+
+Args:
+ bucket: string, Name of the bucket in which the object resides. (required)
+ object: string, Name of the object. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An object.
+ "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
+ "name": "A String", # The name of this object. Required if not specified by URL parameter.
+ "contentLanguage": "A String", # Content-Language of the object data.
+ "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
+ "contentType": "A String", # Content-Type of the object data.
+ "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
+ "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
+ "length": "A String", # Content-Length of the data in bytes.
+ "link": "A String", # Media download link.
+ "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
+ "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
+ },
+ "bucket": "A String", # The bucket containing this object.
+ "contentEncoding": "A String", # Content-Encoding of the object data.
+ "selfLink": "A String", # The link to this object.
+ "owner": { # The owner of the object. This will always be the uploader of the object.
+ "entityId": "A String", # The ID for the entity.
+ "entity": "A String", # The entity, in the form user-userId.
+ },
+ "cacheControl": "A String", # Cache-Control directive for the object data.
+ "acl": [ # Access controls on the object.
+ { # An access-control entry.
+ "domain": "A String", # The domain associated with the entity, if any.
+ "object": "A String", # The name of the object.
+ "bucket": "A String", # The name of the bucket.
+ "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
+ "id": "A String", # The ID of the access-control entry.
+ "role": "A String", # The access permission for the entity. Can be READER or OWNER.
+ "entityId": "A String", # The ID for the entity, if any.
+ "entity": "A String", # The entity holding the permission, in one of the following forms:
+ # - user-userId
+ # - user-email
+ # - group-groupId
+ # - group-email
+ # - domain-domain
+ # - allUsers
+ # - allAuthenticatedUsers Examples:
+ # - The user liz@example.com would be user-liz@example.com.
+ # - The group example@googlegroups.com would be group-example@googlegroups.com.
+ # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
+ "email": "A String", # The email address associated with the entity, if any.
+ "selfLink": "A String", # The link to this access-control entry.
+ },
+ ],
+ "id": "A String", # The ID of the object.
+ "contentDisposition": "A String", # Content-Disposition of the object data.
+ "metadata": { # User-provided metadata, in key/value pairs.
+ "a_key": "A String", # An individual metadata entry.
+ },
+ }
+
+ projection: string, Set of properties to return. Defaults to full.
+ Allowed values
+ full - Include all properties.
+ no_acl - Omit the acl property.
+
+Returns:
+ The media object as a string.
+
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/storage_v1beta2.bucketAccessControls.html b/docs/dyn/storage_v1beta2.bucketAccessControls.html
index b150aea..f745876 100644
--- a/docs/dyn/storage_v1beta2.bucketAccessControls.html
+++ b/docs/dyn/storage_v1beta2.bucketAccessControls.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="storage_v1beta2.html">Cloud Storage API</a> . <a href="storage_v1beta2.bucketAccessControls.html">bucketAccessControls</a></h1>
+<h1><a href="storage_v1beta2.html">Cloud Storage JSON API</a> . <a href="storage_v1beta2.bucketAccessControls.html">bucketAccessControls</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(bucket, entity)</a></code></p>
diff --git a/docs/dyn/storage_v1beta2.buckets.html b/docs/dyn/storage_v1beta2.buckets.html
index 968b224..bab2106 100644
--- a/docs/dyn/storage_v1beta2.buckets.html
+++ b/docs/dyn/storage_v1beta2.buckets.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="storage_v1beta2.html">Cloud Storage API</a> . <a href="storage_v1beta2.buckets.html">buckets</a></h1>
+<h1><a href="storage_v1beta2.html">Cloud Storage JSON API</a> . <a href="storage_v1beta2.buckets.html">buckets</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
@@ -199,13 +199,13 @@
"responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
"A String",
],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
+ "method": [ # The list of HTTP methods on which to include CORS response headers: GET, OPTIONS, POST, etc. Note, "*" is permitted in the list of methods, and means "any method".
"A String",
],
"maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
},
],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "owner": { # The owner of the bucket. This is always the project team's owner group.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form group-groupId.
},
@@ -213,7 +213,7 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
+ "type": "A String", # Type of the action. Currently only Delete is supported.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
@@ -226,7 +226,7 @@
},
"id": "A String", # The ID of the bucket.
"selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
+ "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
}</pre>
</div>
@@ -315,13 +315,13 @@
"responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
"A String",
],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
+ "method": [ # The list of HTTP methods on which to include CORS response headers: GET, OPTIONS, POST, etc. Note, "*" is permitted in the list of methods, and means "any method".
"A String",
],
"maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
},
],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "owner": { # The owner of the bucket. This is always the project team's owner group.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form group-groupId.
},
@@ -329,7 +329,7 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
+ "type": "A String", # Type of the action. Currently only Delete is supported.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
@@ -342,7 +342,7 @@
},
"id": "A String", # The ID of the bucket.
"selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
+ "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
}
projection: string, Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
@@ -429,13 +429,13 @@
"responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
"A String",
],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
+ "method": [ # The list of HTTP methods on which to include CORS response headers: GET, OPTIONS, POST, etc. Note, "*" is permitted in the list of methods, and means "any method".
"A String",
],
"maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
},
],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "owner": { # The owner of the bucket. This is always the project team's owner group.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form group-groupId.
},
@@ -443,7 +443,7 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
+ "type": "A String", # Type of the action. Currently only Delete is supported.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
@@ -456,7 +456,7 @@
},
"id": "A String", # The ID of the bucket.
"selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
+ "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
}</pre>
</div>
@@ -555,13 +555,13 @@
"responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
"A String",
],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
+ "method": [ # The list of HTTP methods on which to include CORS response headers: GET, OPTIONS, POST, etc. Note, "*" is permitted in the list of methods, and means "any method".
"A String",
],
"maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
},
],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "owner": { # The owner of the bucket. This is always the project team's owner group.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form group-groupId.
},
@@ -569,7 +569,7 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
+ "type": "A String", # Type of the action. Currently only Delete is supported.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
@@ -582,7 +582,7 @@
},
"id": "A String", # The ID of the bucket.
"selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
+ "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
},
],
"kind": "storage#buckets", # The kind of item this is. For lists of buckets, this is always storage#buckets.
@@ -688,13 +688,13 @@
"responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
"A String",
],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
+ "method": [ # The list of HTTP methods on which to include CORS response headers: GET, OPTIONS, POST, etc. Note, "*" is permitted in the list of methods, and means "any method".
"A String",
],
"maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
},
],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "owner": { # The owner of the bucket. This is always the project team's owner group.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form group-groupId.
},
@@ -702,7 +702,7 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
+ "type": "A String", # Type of the action. Currently only Delete is supported.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
@@ -715,7 +715,7 @@
},
"id": "A String", # The ID of the bucket.
"selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
+ "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
}
projection: string, Set of properties to return. Defaults to full.
@@ -804,13 +804,13 @@
"responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
"A String",
],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
+ "method": [ # The list of HTTP methods on which to include CORS response headers: GET, OPTIONS, POST, etc. Note, "*" is permitted in the list of methods, and means "any method".
"A String",
],
"maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
},
],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "owner": { # The owner of the bucket. This is always the project team's owner group.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form group-groupId.
},
@@ -818,7 +818,7 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
+ "type": "A String", # Type of the action. Currently only Delete is supported.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
@@ -831,7 +831,7 @@
},
"id": "A String", # The ID of the bucket.
"selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
+ "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
}</pre>
</div>
@@ -920,13 +920,13 @@
"responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
"A String",
],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
+ "method": [ # The list of HTTP methods on which to include CORS response headers: GET, OPTIONS, POST, etc. Note, "*" is permitted in the list of methods, and means "any method".
"A String",
],
"maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
},
],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "owner": { # The owner of the bucket. This is always the project team's owner group.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form group-groupId.
},
@@ -934,7 +934,7 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
+ "type": "A String", # Type of the action. Currently only Delete is supported.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
@@ -947,7 +947,7 @@
},
"id": "A String", # The ID of the bucket.
"selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
+ "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
}
projection: string, Set of properties to return. Defaults to full.
@@ -1036,13 +1036,13 @@
"responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
"A String",
],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
+ "method": [ # The list of HTTP methods on which to include CORS response headers: GET, OPTIONS, POST, etc. Note, "*" is permitted in the list of methods, and means "any method".
"A String",
],
"maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
},
],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
+ "owner": { # The owner of the bucket. This is always the project team's owner group.
"entityId": "A String", # The ID for the entity.
"entity": "A String", # The entity, in the form group-groupId.
},
@@ -1050,7 +1050,7 @@
"rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
{
"action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
+ "type": "A String", # Type of the action. Currently only Delete is supported.
},
"condition": { # The condition(s) under which the action will be taken.
"isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
@@ -1063,7 +1063,7 @@
},
"id": "A String", # The ID of the bucket.
"selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
+ "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
}</pre>
</div>
diff --git a/docs/dyn/storage_v1beta2.channels.html b/docs/dyn/storage_v1beta2.channels.html
index c8fc6e2..da41ee4 100644
--- a/docs/dyn/storage_v1beta2.channels.html
+++ b/docs/dyn/storage_v1beta2.channels.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="storage_v1beta2.html">Cloud Storage API</a> . <a href="storage_v1beta2.channels.html">channels</a></h1>
+<h1><a href="storage_v1beta2.html">Cloud Storage JSON API</a> . <a href="storage_v1beta2.channels.html">channels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#stop">stop(body)</a></code></p>
diff --git a/docs/dyn/storage_v1beta2.defaultObjectAccessControls.html b/docs/dyn/storage_v1beta2.defaultObjectAccessControls.html
index 4639e15..57e00c6 100644
--- a/docs/dyn/storage_v1beta2.defaultObjectAccessControls.html
+++ b/docs/dyn/storage_v1beta2.defaultObjectAccessControls.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="storage_v1beta2.html">Cloud Storage API</a> . <a href="storage_v1beta2.defaultObjectAccessControls.html">defaultObjectAccessControls</a></h1>
+<h1><a href="storage_v1beta2.html">Cloud Storage JSON API</a> . <a href="storage_v1beta2.defaultObjectAccessControls.html">defaultObjectAccessControls</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(bucket, entity)</a></code></p>
@@ -210,8 +210,8 @@
Args:
bucket: string, Name of a bucket. (required)
- ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's current metageneration matches the given value.
- ifMetagenerationNotMatch: string, Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
+ ifMetagenerationMatch: string, If present, only return default ACL listing if the bucket's current metageneration matches this value.
+ ifMetagenerationNotMatch: string, If present, only return default ACL listing if the bucket's current metageneration does not match the given value.
Returns:
An object of the form:
diff --git a/docs/dyn/storage_v1beta2.html b/docs/dyn/storage_v1beta2.html
index 31c606a..92bb00e 100644
--- a/docs/dyn/storage_v1beta2.html
+++ b/docs/dyn/storage_v1beta2.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="storage_v1beta2.html">Cloud Storage API</a></h1>
+<h1><a href="storage_v1beta2.html">Cloud Storage JSON API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="storage_v1beta2.bucketAccessControls.html">bucketAccessControls()</a></code>
@@ -104,4 +104,25 @@
</p>
<p class="firstline">Returns the objects Resource.</p>
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/storage_v1beta2.objectAccessControls.html b/docs/dyn/storage_v1beta2.objectAccessControls.html
index 85c5a08..1e2009f 100644
--- a/docs/dyn/storage_v1beta2.objectAccessControls.html
+++ b/docs/dyn/storage_v1beta2.objectAccessControls.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="storage_v1beta2.html">Cloud Storage API</a> . <a href="storage_v1beta2.objectAccessControls.html">objectAccessControls</a></h1>
+<h1><a href="storage_v1beta2.html">Cloud Storage JSON API</a> . <a href="storage_v1beta2.objectAccessControls.html">objectAccessControls</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(bucket, object, entity, generation=None)</a></code></p>
diff --git a/docs/dyn/storage_v1beta2.objects.html b/docs/dyn/storage_v1beta2.objects.html
index cd957d7..48ecde9 100644
--- a/docs/dyn/storage_v1beta2.objects.html
+++ b/docs/dyn/storage_v1beta2.objects.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="storage_v1beta2.html">Cloud Storage API</a> . <a href="storage_v1beta2.objects.html">objects</a></h1>
+<h1><a href="storage_v1beta2.html">Cloud Storage JSON API</a> . <a href="storage_v1beta2.objects.html">objects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#compose">compose(destinationBucket, destinationObject, body, ifMetagenerationMatch=None, ifGenerationMatch=None)</a></code></p>
diff --git a/docs/dyn/manager_v1beta2.html b/docs/dyn/surveys_v2.html
similarity index 81%
copy from docs/dyn/manager_v1beta2.html
copy to docs/dyn/surveys_v2.html
index 44fc028..a80307b 100644
--- a/docs/dyn/manager_v1beta2.html
+++ b/docs/dyn/surveys_v2.html
@@ -72,17 +72,22 @@
</style>
-<h1><a href="manager_v1beta2.html">Deployment Manager API</a></h1>
+<h1><a href="surveys_v2.html">Surveys API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="manager_v1beta2.deployments.html">deployments()</a></code>
+ <code><a href="surveys_v2.mobileapppanels.html">mobileapppanels()</a></code>
</p>
-<p class="firstline">Returns the deployments Resource.</p>
+<p class="firstline">Returns the mobileapppanels Resource.</p>
<p class="toc_element">
- <code><a href="manager_v1beta2.templates.html">templates()</a></code>
+ <code><a href="surveys_v2.results.html">results()</a></code>
</p>
-<p class="firstline">Returns the templates Resource.</p>
+<p class="firstline">Returns the results Resource.</p>
+
+<p class="toc_element">
+ <code><a href="surveys_v2.surveys.html">surveys()</a></code>
+</p>
+<p class="firstline">Returns the surveys Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/surveys_v2.mobileapppanels.html b/docs/dyn/surveys_v2.mobileapppanels.html
new file mode 100644
index 0000000..e5827c0
--- /dev/null
+++ b/docs/dyn/surveys_v2.mobileapppanels.html
@@ -0,0 +1,183 @@
+<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="surveys_v2.html">Surveys API</a> . <a href="surveys_v2.mobileapppanels.html">mobileapppanels</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(panelId)</a></code></p>
+<p class="firstline">Retrieves a MobileAppPanel that is available to the authenticated user.</p>
+<p class="toc_element">
+ <code><a href="#list">list(startIndex=None, maxResults=None, token=None)</a></code></p>
+<p class="firstline">Lists the MobileAppPanels available to the authenticated user.</p>
+<p class="toc_element">
+ <code><a href="#update">update(panelId, body)</a></code></p>
+<p class="firstline">Updates a MobileAppPanel. Currently the only property that can be updated is the owners property.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(panelId)</code>
+ <pre>Retrieves a MobileAppPanel that is available to the authenticated user.
+
+Args:
+ panelId: string, External URL ID for the panel. (required)
+
+Returns:
+ An object of the form:
+
+ { # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
+ "owners": [ # List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels.
+ "A String",
+ ],
+ "mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
+ "name": "A String", # Human readable name of the audience panel.
+ "language": "A String", # Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language.
+ "country": "A String", # Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country.
+ "isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(startIndex=None, maxResults=None, token=None)</code>
+ <pre>Lists the MobileAppPanels available to the authenticated user.
+
+Args:
+ startIndex: integer, A parameter
+ maxResults: integer, A parameter
+ token: string, A parameter
+
+Returns:
+ An object of the form:
+
+ {
+ "tokenPagination": {
+ "nextPageToken": "A String",
+ "previousPageToken": "A String",
+ },
+ "pageInfo": {
+ "totalResults": 42,
+ "startIndex": 42,
+ "resultPerPage": 42,
+ },
+ "resources": [ # An individual predefined panel of Opinion Rewards mobile users.
+ { # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
+ "owners": [ # List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels.
+ "A String",
+ ],
+ "mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
+ "name": "A String", # Human readable name of the audience panel.
+ "language": "A String", # Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language.
+ "country": "A String", # Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country.
+ "isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
+ },
+ ],
+ "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(panelId, body)</code>
+ <pre>Updates a MobileAppPanel. Currently the only property that can be updated is the owners property.
+
+Args:
+ panelId: string, External URL ID for the panel. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
+ "owners": [ # List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels.
+ "A String",
+ ],
+ "mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
+ "name": "A String", # Human readable name of the audience panel.
+ "language": "A String", # Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language.
+ "country": "A String", # Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country.
+ "isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
+ "owners": [ # List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels.
+ "A String",
+ ],
+ "mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
+ "name": "A String", # Human readable name of the audience panel.
+ "language": "A String", # Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language.
+ "country": "A String", # Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country.
+ "isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/surveys_v2.results.html b/docs/dyn/surveys_v2.results.html
new file mode 100644
index 0000000..bba8d6f
--- /dev/null
+++ b/docs/dyn/surveys_v2.results.html
@@ -0,0 +1,113 @@
+<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="surveys_v2.html">Surveys API</a> . <a href="surveys_v2.results.html">results</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(surveyUrlId)</a></code></p>
+<p class="firstline">Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.</p>
+<p class="toc_element">
+ <code><a href="#get_media">get_media(surveyUrlId)</a></code></p>
+<p class="firstline">Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(surveyUrlId)</code>
+ <pre>Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.
+
+Args:
+ surveyUrlId: string, External URL ID for the survey. (required)
+
+Returns:
+ An object of the form:
+
+ { # Reference to the current results for a given survey.
+ "status": "A String", # Human readable string describing the status of the request.
+ "surveyUrlId": "A String", # External survey ID as viewable by survey owners in the editor view.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get_media">get_media(surveyUrlId)</code>
+ <pre>Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.
+
+Args:
+ surveyUrlId: string, External URL ID for the survey. (required)
+
+Returns:
+ The media object as a string.
+
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/surveys_v2.surveys.html b/docs/dyn/surveys_v2.surveys.html
new file mode 100644
index 0000000..13016b5
--- /dev/null
+++ b/docs/dyn/surveys_v2.surveys.html
@@ -0,0 +1,766 @@
+<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="surveys_v2.html">Surveys API</a> . <a href="surveys_v2.surveys.html">surveys</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(surveyUrlId)</a></code></p>
+<p class="firstline">Removes a survey from view in all user GET requests.</p>
+<p class="toc_element">
+ <code><a href="#get">get(surveyUrlId)</a></code></p>
+<p class="firstline">Retrieves information about the specified survey.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(body)</a></code></p>
+<p class="firstline">Creates a survey.</p>
+<p class="toc_element">
+ <code><a href="#list">list(startIndex=None, maxResults=None, token=None)</a></code></p>
+<p class="firstline">Lists the surveys owned by the authenticated user.</p>
+<p class="toc_element">
+ <code><a href="#start">start(resourceId, body)</a></code></p>
+<p class="firstline">Begins running a survey.</p>
+<p class="toc_element">
+ <code><a href="#stop">stop(resourceId)</a></code></p>
+<p class="firstline">Stops a running survey.</p>
+<p class="toc_element">
+ <code><a href="#update">update(surveyUrlId, body)</a></code></p>
+<p class="firstline">Updates a survey. Currently the only property that can be updated is the owners property.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(surveyUrlId)</code>
+ <pre>Removes a survey from view in all user GET requests.
+
+Args:
+ surveyUrlId: string, External URL ID for the survey. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(surveyUrlId)</code>
+ <pre>Retrieves information about the specified survey.
+
+Args:
+ surveyUrlId: string, External URL ID for the survey. (required)
+
+Returns:
+ An object of the form:
+
+ { # Representation of an individual survey object.
+ "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
+ "A String",
+ ],
+ "description": "A String", # Text description of the survey.
+ "title": "A String", # Optional name that will be given to the survey.
+ "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
+ "state": "A String", # State that the survey is in.
+ "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
+ "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
+ "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
+ "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
+ "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
+ "A String",
+ ],
+ "populationSource": "A String", # Online population source where the respondents are sampled from.
+ "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
+ "A String",
+ ],
+ "gender": "A String", # Optional gender to target.
+ },
+ "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
+ "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
+ "currencyCode": "A String", # Currency code that the cost is given in.
+ "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
+ "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
+ },
+ "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
+ "questions": [ # List of questions defining the survey.
+ { # Message defining the question specifications.
+ "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
+ "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
+ "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
+ "A String",
+ ],
+ "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
+ "question": "A String", # Required question text shown to the respondent.
+ "numStars": "A String", # Number of stars to use for ratings questions.
+ "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
+ "videoId": "A String", # The YouTube video ID to be show in video questions.
+ "answers": [ # Required list of answer options for a question.
+ "A String",
+ ],
+ "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
+ "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
+ "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
+ "images": [
+ { # Container object for image data and alt_text.
+ "url": "A String", # The read-only URL for the hosted images.
+ "altText": "A String", # The alt text property used in image tags is required for all images.
+ "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
+ },
+ ],
+ "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
+ "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
+ "A String",
+ ],
+ "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
+ "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
+ "openTextPlaceholder": "A String", # Placeholder text for an open text question.
+ },
+ ],
+ "wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(body)</code>
+ <pre>Creates a survey.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Representation of an individual survey object.
+ "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
+ "A String",
+ ],
+ "description": "A String", # Text description of the survey.
+ "title": "A String", # Optional name that will be given to the survey.
+ "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
+ "state": "A String", # State that the survey is in.
+ "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
+ "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
+ "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
+ "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
+ "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
+ "A String",
+ ],
+ "populationSource": "A String", # Online population source where the respondents are sampled from.
+ "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
+ "A String",
+ ],
+ "gender": "A String", # Optional gender to target.
+ },
+ "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
+ "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
+ "currencyCode": "A String", # Currency code that the cost is given in.
+ "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
+ "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
+ },
+ "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
+ "questions": [ # List of questions defining the survey.
+ { # Message defining the question specifications.
+ "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
+ "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
+ "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
+ "A String",
+ ],
+ "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
+ "question": "A String", # Required question text shown to the respondent.
+ "numStars": "A String", # Number of stars to use for ratings questions.
+ "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
+ "videoId": "A String", # The YouTube video ID to be show in video questions.
+ "answers": [ # Required list of answer options for a question.
+ "A String",
+ ],
+ "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
+ "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
+ "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
+ "images": [
+ { # Container object for image data and alt_text.
+ "url": "A String", # The read-only URL for the hosted images.
+ "altText": "A String", # The alt text property used in image tags is required for all images.
+ "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
+ },
+ ],
+ "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
+ "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
+ "A String",
+ ],
+ "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
+ "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
+ "openTextPlaceholder": "A String", # Placeholder text for an open text question.
+ },
+ ],
+ "wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Representation of an individual survey object.
+ "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
+ "A String",
+ ],
+ "description": "A String", # Text description of the survey.
+ "title": "A String", # Optional name that will be given to the survey.
+ "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
+ "state": "A String", # State that the survey is in.
+ "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
+ "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
+ "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
+ "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
+ "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
+ "A String",
+ ],
+ "populationSource": "A String", # Online population source where the respondents are sampled from.
+ "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
+ "A String",
+ ],
+ "gender": "A String", # Optional gender to target.
+ },
+ "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
+ "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
+ "currencyCode": "A String", # Currency code that the cost is given in.
+ "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
+ "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
+ },
+ "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
+ "questions": [ # List of questions defining the survey.
+ { # Message defining the question specifications.
+ "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
+ "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
+ "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
+ "A String",
+ ],
+ "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
+ "question": "A String", # Required question text shown to the respondent.
+ "numStars": "A String", # Number of stars to use for ratings questions.
+ "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
+ "videoId": "A String", # The YouTube video ID to be show in video questions.
+ "answers": [ # Required list of answer options for a question.
+ "A String",
+ ],
+ "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
+ "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
+ "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
+ "images": [
+ { # Container object for image data and alt_text.
+ "url": "A String", # The read-only URL for the hosted images.
+ "altText": "A String", # The alt text property used in image tags is required for all images.
+ "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
+ },
+ ],
+ "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
+ "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
+ "A String",
+ ],
+ "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
+ "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
+ "openTextPlaceholder": "A String", # Placeholder text for an open text question.
+ },
+ ],
+ "wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(startIndex=None, maxResults=None, token=None)</code>
+ <pre>Lists the surveys owned by the authenticated user.
+
+Args:
+ startIndex: integer, A parameter
+ maxResults: integer, A parameter
+ token: string, A parameter
+
+Returns:
+ An object of the form:
+
+ {
+ "tokenPagination": {
+ "nextPageToken": "A String",
+ "previousPageToken": "A String",
+ },
+ "pageInfo": {
+ "totalResults": 42,
+ "startIndex": 42,
+ "resultPerPage": 42,
+ },
+ "resources": [ # An individual survey resource.
+ { # Representation of an individual survey object.
+ "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
+ "A String",
+ ],
+ "description": "A String", # Text description of the survey.
+ "title": "A String", # Optional name that will be given to the survey.
+ "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
+ "state": "A String", # State that the survey is in.
+ "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
+ "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
+ "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
+ "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
+ "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
+ "A String",
+ ],
+ "populationSource": "A String", # Online population source where the respondents are sampled from.
+ "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
+ "A String",
+ ],
+ "gender": "A String", # Optional gender to target.
+ },
+ "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
+ "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
+ "currencyCode": "A String", # Currency code that the cost is given in.
+ "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
+ "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
+ },
+ "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
+ "questions": [ # List of questions defining the survey.
+ { # Message defining the question specifications.
+ "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
+ "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
+ "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
+ "A String",
+ ],
+ "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
+ "question": "A String", # Required question text shown to the respondent.
+ "numStars": "A String", # Number of stars to use for ratings questions.
+ "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
+ "videoId": "A String", # The YouTube video ID to be show in video questions.
+ "answers": [ # Required list of answer options for a question.
+ "A String",
+ ],
+ "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
+ "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
+ "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
+ "images": [
+ { # Container object for image data and alt_text.
+ "url": "A String", # The read-only URL for the hosted images.
+ "altText": "A String", # The alt text property used in image tags is required for all images.
+ "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
+ },
+ ],
+ "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
+ "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
+ "A String",
+ ],
+ "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
+ "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
+ "openTextPlaceholder": "A String", # Placeholder text for an open text question.
+ },
+ ],
+ "wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
+ },
+ ],
+ "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="start">start(resourceId, body)</code>
+ <pre>Begins running a survey.
+
+Args:
+ resourceId: string, A parameter (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "maxCostPerResponseNanos": "A String", # Threshold to start a survey automically if the quoted prices is less than or equal to this value. See Survey.Cost for more details.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "resource": { # Representation of an individual survey object. # Survey object containing the specification of the started Survey.
+ "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
+ "A String",
+ ],
+ "description": "A String", # Text description of the survey.
+ "title": "A String", # Optional name that will be given to the survey.
+ "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
+ "state": "A String", # State that the survey is in.
+ "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
+ "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
+ "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
+ "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
+ "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
+ "A String",
+ ],
+ "populationSource": "A String", # Online population source where the respondents are sampled from.
+ "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
+ "A String",
+ ],
+ "gender": "A String", # Optional gender to target.
+ },
+ "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
+ "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
+ "currencyCode": "A String", # Currency code that the cost is given in.
+ "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
+ "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
+ },
+ "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
+ "questions": [ # List of questions defining the survey.
+ { # Message defining the question specifications.
+ "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
+ "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
+ "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
+ "A String",
+ ],
+ "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
+ "question": "A String", # Required question text shown to the respondent.
+ "numStars": "A String", # Number of stars to use for ratings questions.
+ "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
+ "videoId": "A String", # The YouTube video ID to be show in video questions.
+ "answers": [ # Required list of answer options for a question.
+ "A String",
+ ],
+ "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
+ "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
+ "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
+ "images": [
+ { # Container object for image data and alt_text.
+ "url": "A String", # The read-only URL for the hosted images.
+ "altText": "A String", # The alt text property used in image tags is required for all images.
+ "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
+ },
+ ],
+ "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
+ "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
+ "A String",
+ ],
+ "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
+ "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
+ "openTextPlaceholder": "A String", # Placeholder text for an open text question.
+ },
+ ],
+ "wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
+ },
+ "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="stop">stop(resourceId)</code>
+ <pre>Stops a running survey.
+
+Args:
+ resourceId: string, A parameter (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "resource": { # Representation of an individual survey object. # Survey object containing the specification of the stopped Survey.
+ "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
+ "A String",
+ ],
+ "description": "A String", # Text description of the survey.
+ "title": "A String", # Optional name that will be given to the survey.
+ "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
+ "state": "A String", # State that the survey is in.
+ "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
+ "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
+ "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
+ "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
+ "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
+ "A String",
+ ],
+ "populationSource": "A String", # Online population source where the respondents are sampled from.
+ "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
+ "A String",
+ ],
+ "gender": "A String", # Optional gender to target.
+ },
+ "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
+ "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
+ "currencyCode": "A String", # Currency code that the cost is given in.
+ "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
+ "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
+ },
+ "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
+ "questions": [ # List of questions defining the survey.
+ { # Message defining the question specifications.
+ "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
+ "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
+ "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
+ "A String",
+ ],
+ "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
+ "question": "A String", # Required question text shown to the respondent.
+ "numStars": "A String", # Number of stars to use for ratings questions.
+ "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
+ "videoId": "A String", # The YouTube video ID to be show in video questions.
+ "answers": [ # Required list of answer options for a question.
+ "A String",
+ ],
+ "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
+ "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
+ "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
+ "images": [
+ { # Container object for image data and alt_text.
+ "url": "A String", # The read-only URL for the hosted images.
+ "altText": "A String", # The alt text property used in image tags is required for all images.
+ "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
+ },
+ ],
+ "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
+ "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
+ "A String",
+ ],
+ "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
+ "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
+ "openTextPlaceholder": "A String", # Placeholder text for an open text question.
+ },
+ ],
+ "wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
+ },
+ "requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(surveyUrlId, body)</code>
+ <pre>Updates a survey. Currently the only property that can be updated is the owners property.
+
+Args:
+ surveyUrlId: string, External URL ID for the survey. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Representation of an individual survey object.
+ "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
+ "A String",
+ ],
+ "description": "A String", # Text description of the survey.
+ "title": "A String", # Optional name that will be given to the survey.
+ "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
+ "state": "A String", # State that the survey is in.
+ "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
+ "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
+ "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
+ "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
+ "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
+ "A String",
+ ],
+ "populationSource": "A String", # Online population source where the respondents are sampled from.
+ "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
+ "A String",
+ ],
+ "gender": "A String", # Optional gender to target.
+ },
+ "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
+ "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
+ "currencyCode": "A String", # Currency code that the cost is given in.
+ "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
+ "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
+ },
+ "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
+ "questions": [ # List of questions defining the survey.
+ { # Message defining the question specifications.
+ "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
+ "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
+ "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
+ "A String",
+ ],
+ "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
+ "question": "A String", # Required question text shown to the respondent.
+ "numStars": "A String", # Number of stars to use for ratings questions.
+ "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
+ "videoId": "A String", # The YouTube video ID to be show in video questions.
+ "answers": [ # Required list of answer options for a question.
+ "A String",
+ ],
+ "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
+ "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
+ "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
+ "images": [
+ { # Container object for image data and alt_text.
+ "url": "A String", # The read-only URL for the hosted images.
+ "altText": "A String", # The alt text property used in image tags is required for all images.
+ "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
+ },
+ ],
+ "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
+ "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
+ "A String",
+ ],
+ "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
+ "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
+ "openTextPlaceholder": "A String", # Placeholder text for an open text question.
+ },
+ ],
+ "wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Representation of an individual survey object.
+ "owners": [ # List of email addresses for survey owners. Must contain at least the address of the user making the API call.
+ "A String",
+ ],
+ "description": "A String", # Text description of the survey.
+ "title": "A String", # Optional name that will be given to the survey.
+ "customerData": "A String", # Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
+ "state": "A String", # State that the survey is in.
+ "audience": { # Specifications for the target audience of a survey run through the API. # Targeting-criteria message containing demographic information
+ "countrySubdivision": "A String", # Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
+ "mobileAppPanelId": "A String", # Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field.
+ "country": "A String", # Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
+ "ages": [ # Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
+ "A String",
+ ],
+ "populationSource": "A String", # Online population source where the respondents are sampled from.
+ "languages": [ # Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
+ "A String",
+ ],
+ "gender": "A String", # Optional gender to target.
+ },
+ "cost": { # Message defining the cost to run a given survey through API. # Cost to run the survey and collect the necessary number of responses.
+ "nanos": "A String", # Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
+ "currencyCode": "A String", # Currency code that the cost is given in.
+ "costPerResponseNanos": "A String", # Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
+ "maxCostPerResponseNanos": "A String", # Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days.
+ },
+ "surveyUrlId": "A String", # Unique survey ID, that is viewable in the URL of the Survey Creator UI
+ "questions": [ # List of questions defining the survey.
+ { # Message defining the question specifications.
+ "highValueLabel": "A String", # For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
+ "mustPickSuggestion": True or False, # Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
+ "thresholdAnswers": [ # The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
+ "A String",
+ ],
+ "sentimentText": "A String", # Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
+ "question": "A String", # Required question text shown to the respondent.
+ "numStars": "A String", # Number of stars to use for ratings questions.
+ "lowValueLabel": "A String", # For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.
+ "videoId": "A String", # The YouTube video ID to be show in video questions.
+ "answers": [ # Required list of answer options for a question.
+ "A String",
+ ],
+ "lastAnswerPositionPinned": True or False, # Currently only support pinning an answer option to the last position.
+ "hasOther": True or False, # Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
+ "unitOfMeasurementLabel": "A String", # Optional unit of measurement for display (for example: hours, people, miles).
+ "images": [
+ { # Container object for image data and alt_text.
+ "url": "A String", # The read-only URL for the hosted images.
+ "altText": "A String", # The alt text property used in image tags is required for all images.
+ "data": "A String", # Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
+ },
+ ],
+ "singleLineResponse": True or False, # Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
+ "openTextSuggestions": [ # A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
+ "A String",
+ ],
+ "type": "A String", # Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
+ "answerOrder": "A String", # The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
+ "openTextPlaceholder": "A String", # Placeholder text for an open text question.
+ },
+ ],
+ "wantedResponseCount": 42, # Number of responses desired for the survey.
+ "rejectionReason": { # Message representing why the survey was rejected from review, if it was. # Reason for the survey being rejected. Only present if the survey state is 'rejected'.
+ "explanation": "A String", # A human-readable explanation of what was wrong with the survey.
+ "type": "A String", # Which category of rejection this was. See the GCS Help Center for additional details on each category.
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/tagmanager_v1.accounts.containers.macros.html b/docs/dyn/tagmanager_v1.accounts.containers.macros.html
deleted file mode 100644
index fd2a1a1..0000000
--- a/docs/dyn/tagmanager_v1.accounts.containers.macros.html
+++ /dev/null
@@ -1,387 +0,0 @@
-<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="tagmanager_v1.html">Tag Manager API</a> . <a href="tagmanager_v1.accounts.html">accounts</a> . <a href="tagmanager_v1.accounts.containers.html">containers</a> . <a href="tagmanager_v1.accounts.containers.macros.html">macros</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#create">create(accountId, containerId, body)</a></code></p>
-<p class="firstline">Creates a GTM Macro.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(accountId, containerId, macroId)</a></code></p>
-<p class="firstline">Deletes a GTM Macro.</p>
-<p class="toc_element">
- <code><a href="#get">get(accountId, containerId, macroId)</a></code></p>
-<p class="firstline">Gets a GTM Macro.</p>
-<p class="toc_element">
- <code><a href="#list">list(accountId, containerId)</a></code></p>
-<p class="firstline">Lists all GTM Macros of a Container.</p>
-<p class="toc_element">
- <code><a href="#update">update(accountId, containerId, macroId, body, fingerprint=None)</a></code></p>
-<p class="firstline">Updates a GTM Macro.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(accountId, containerId, body)</code>
- <pre>Creates a GTM Macro.
-
-Args:
- accountId: string, The GTM Account ID. (required)
- containerId: string, The GTM Container ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Google Tag Manager Macro.
- "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
- "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
- "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
- "containerId": "A String", # GTM Container ID.
- "type": "A String", # GTM Macro Type.
- "notes": "A String", # User notes on how to apply this macro in the container.
- "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
- "A String",
- ],
- "name": "A String", # Macro display name.
- "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
- "A String",
- ],
- "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
- "parameter": [ # The macro's parameters.
- { # Represents a Google Tag Manager Parameter.
- "map": [ # This map parameter's parameters (must have keys; keys must be unique).
- # Object with schema name: Parameter
- ],
- "list": [ # This list parameter's parameters (keys will be ignored).
- # Object with schema name: Parameter
- ],
- "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
- "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
- "type": "A String", # The parameter type. Valid values are:
- # - boolean: The value represents a boolean, represented as 'true' or 'false'
- # - integer: The value represents a 64-bit signed integer value, in base 10
- # - list: A list of parameters should be specified
- # - map: A map of parameters should be specified
- # - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
- },
- ],
- "parentFolderId": "A String", # Parent folder id.
- "accountId": "A String", # GTM Account ID.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a Google Tag Manager Macro.
- "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
- "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
- "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
- "containerId": "A String", # GTM Container ID.
- "type": "A String", # GTM Macro Type.
- "notes": "A String", # User notes on how to apply this macro in the container.
- "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
- "A String",
- ],
- "name": "A String", # Macro display name.
- "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
- "A String",
- ],
- "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
- "parameter": [ # The macro's parameters.
- { # Represents a Google Tag Manager Parameter.
- "map": [ # This map parameter's parameters (must have keys; keys must be unique).
- # Object with schema name: Parameter
- ],
- "list": [ # This list parameter's parameters (keys will be ignored).
- # Object with schema name: Parameter
- ],
- "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
- "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
- "type": "A String", # The parameter type. Valid values are:
- # - boolean: The value represents a boolean, represented as 'true' or 'false'
- # - integer: The value represents a 64-bit signed integer value, in base 10
- # - list: A list of parameters should be specified
- # - map: A map of parameters should be specified
- # - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
- },
- ],
- "parentFolderId": "A String", # Parent folder id.
- "accountId": "A String", # GTM Account ID.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(accountId, containerId, macroId)</code>
- <pre>Deletes a GTM Macro.
-
-Args:
- accountId: string, The GTM Account ID. (required)
- containerId: string, The GTM Container ID. (required)
- macroId: string, The GTM Macro ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(accountId, containerId, macroId)</code>
- <pre>Gets a GTM Macro.
-
-Args:
- accountId: string, The GTM Account ID. (required)
- containerId: string, The GTM Container ID. (required)
- macroId: string, The GTM Macro ID. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a Google Tag Manager Macro.
- "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
- "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
- "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
- "containerId": "A String", # GTM Container ID.
- "type": "A String", # GTM Macro Type.
- "notes": "A String", # User notes on how to apply this macro in the container.
- "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
- "A String",
- ],
- "name": "A String", # Macro display name.
- "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
- "A String",
- ],
- "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
- "parameter": [ # The macro's parameters.
- { # Represents a Google Tag Manager Parameter.
- "map": [ # This map parameter's parameters (must have keys; keys must be unique).
- # Object with schema name: Parameter
- ],
- "list": [ # This list parameter's parameters (keys will be ignored).
- # Object with schema name: Parameter
- ],
- "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
- "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
- "type": "A String", # The parameter type. Valid values are:
- # - boolean: The value represents a boolean, represented as 'true' or 'false'
- # - integer: The value represents a 64-bit signed integer value, in base 10
- # - list: A list of parameters should be specified
- # - map: A map of parameters should be specified
- # - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
- },
- ],
- "parentFolderId": "A String", # Parent folder id.
- "accountId": "A String", # GTM Account ID.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(accountId, containerId)</code>
- <pre>Lists all GTM Macros of a Container.
-
-Args:
- accountId: string, The GTM Account ID. (required)
- containerId: string, The GTM Container ID. (required)
-
-Returns:
- An object of the form:
-
- { # List Macros Response.
- "macros": [ # All GTM Macros of a GTM Container.
- { # Represents a Google Tag Manager Macro.
- "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
- "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
- "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
- "containerId": "A String", # GTM Container ID.
- "type": "A String", # GTM Macro Type.
- "notes": "A String", # User notes on how to apply this macro in the container.
- "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
- "A String",
- ],
- "name": "A String", # Macro display name.
- "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
- "A String",
- ],
- "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
- "parameter": [ # The macro's parameters.
- { # Represents a Google Tag Manager Parameter.
- "map": [ # This map parameter's parameters (must have keys; keys must be unique).
- # Object with schema name: Parameter
- ],
- "list": [ # This list parameter's parameters (keys will be ignored).
- # Object with schema name: Parameter
- ],
- "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
- "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
- "type": "A String", # The parameter type. Valid values are:
- # - boolean: The value represents a boolean, represented as 'true' or 'false'
- # - integer: The value represents a 64-bit signed integer value, in base 10
- # - list: A list of parameters should be specified
- # - map: A map of parameters should be specified
- # - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
- },
- ],
- "parentFolderId": "A String", # Parent folder id.
- "accountId": "A String", # GTM Account ID.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(accountId, containerId, macroId, body, fingerprint=None)</code>
- <pre>Updates a GTM Macro.
-
-Args:
- accountId: string, The GTM Account ID. (required)
- containerId: string, The GTM Container ID. (required)
- macroId: string, The GTM Macro ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Google Tag Manager Macro.
- "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
- "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
- "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
- "containerId": "A String", # GTM Container ID.
- "type": "A String", # GTM Macro Type.
- "notes": "A String", # User notes on how to apply this macro in the container.
- "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
- "A String",
- ],
- "name": "A String", # Macro display name.
- "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
- "A String",
- ],
- "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
- "parameter": [ # The macro's parameters.
- { # Represents a Google Tag Manager Parameter.
- "map": [ # This map parameter's parameters (must have keys; keys must be unique).
- # Object with schema name: Parameter
- ],
- "list": [ # This list parameter's parameters (keys will be ignored).
- # Object with schema name: Parameter
- ],
- "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
- "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
- "type": "A String", # The parameter type. Valid values are:
- # - boolean: The value represents a boolean, represented as 'true' or 'false'
- # - integer: The value represents a 64-bit signed integer value, in base 10
- # - list: A list of parameters should be specified
- # - map: A map of parameters should be specified
- # - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
- },
- ],
- "parentFolderId": "A String", # Parent folder id.
- "accountId": "A String", # GTM Account ID.
- }
-
- fingerprint: string, When provided, this fingerprint must match the fingerprint of the macro in storage.
-
-Returns:
- An object of the form:
-
- { # Represents a Google Tag Manager Macro.
- "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
- "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
- "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
- "containerId": "A String", # GTM Container ID.
- "type": "A String", # GTM Macro Type.
- "notes": "A String", # User notes on how to apply this macro in the container.
- "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
- "A String",
- ],
- "name": "A String", # Macro display name.
- "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.
- "A String",
- ],
- "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
- "parameter": [ # The macro's parameters.
- { # Represents a Google Tag Manager Parameter.
- "map": [ # This map parameter's parameters (must have keys; keys must be unique).
- # Object with schema name: Parameter
- ],
- "list": [ # This list parameter's parameters (keys will be ignored).
- # Object with schema name: Parameter
- ],
- "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
- "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
- "type": "A String", # The parameter type. Valid values are:
- # - boolean: The value represents a boolean, represented as 'true' or 'false'
- # - integer: The value represents a 64-bit signed integer value, in base 10
- # - list: A list of parameters should be specified
- # - map: A map of parameters should be specified
- # - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
- },
- ],
- "parentFolderId": "A String", # Parent folder id.
- "accountId": "A String", # GTM Account ID.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/tagmanager_v1.accounts.containers.rules.html b/docs/dyn/tagmanager_v1.accounts.containers.rules.html
deleted file mode 100644
index 35ebb48..0000000
--- a/docs/dyn/tagmanager_v1.accounts.containers.rules.html
+++ /dev/null
@@ -1,381 +0,0 @@
-<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="tagmanager_v1.html">Tag Manager API</a> . <a href="tagmanager_v1.accounts.html">accounts</a> . <a href="tagmanager_v1.accounts.containers.html">containers</a> . <a href="tagmanager_v1.accounts.containers.rules.html">rules</a></h1>
-<h2>Instance Methods</h2>
-<p class="toc_element">
- <code><a href="#create">create(accountId, containerId, body)</a></code></p>
-<p class="firstline">Creates a GTM Rule.</p>
-<p class="toc_element">
- <code><a href="#delete">delete(accountId, containerId, ruleId)</a></code></p>
-<p class="firstline">Deletes a GTM Rule.</p>
-<p class="toc_element">
- <code><a href="#get">get(accountId, containerId, ruleId)</a></code></p>
-<p class="firstline">Gets a GTM Rule.</p>
-<p class="toc_element">
- <code><a href="#list">list(accountId, containerId)</a></code></p>
-<p class="firstline">Lists all GTM Rules of a Container.</p>
-<p class="toc_element">
- <code><a href="#update">update(accountId, containerId, ruleId, body, fingerprint=None)</a></code></p>
-<p class="firstline">Updates a GTM Rule.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(accountId, containerId, body)</code>
- <pre>Creates a GTM Rule.
-
-Args:
- accountId: string, The GTM Account ID. (required)
- containerId: string, The GTM Container ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Google Tag Manager Rule.
- "name": "A String", # Rule display name.
- "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
- "notes": "A String", # User notes on how to apply this rule in the container.
- "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
- "accountId": "A String", # GTM Account ID.
- "condition": [ # The list of conditions that make up this rule (implicit AND between them).
- { # Represents a predicate.
- "type": "A String", # The type of operator for this condition.
- "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
- # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
- # - At this time, the left operand (arg0) must be a reference to a macro.
- # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
- # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
- { # Represents a Google Tag Manager Parameter.
- "map": [ # This map parameter's parameters (must have keys; keys must be unique).
- # Object with schema name: Parameter
- ],
- "list": [ # This list parameter's parameters (keys will be ignored).
- # Object with schema name: Parameter
- ],
- "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
- "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
- "type": "A String", # The parameter type. Valid values are:
- # - boolean: The value represents a boolean, represented as 'true' or 'false'
- # - integer: The value represents a 64-bit signed integer value, in base 10
- # - list: A list of parameters should be specified
- # - map: A map of parameters should be specified
- # - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
- },
- ],
- },
- ],
- "containerId": "A String", # GTM Container ID.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a Google Tag Manager Rule.
- "name": "A String", # Rule display name.
- "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
- "notes": "A String", # User notes on how to apply this rule in the container.
- "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
- "accountId": "A String", # GTM Account ID.
- "condition": [ # The list of conditions that make up this rule (implicit AND between them).
- { # Represents a predicate.
- "type": "A String", # The type of operator for this condition.
- "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
- # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
- # - At this time, the left operand (arg0) must be a reference to a macro.
- # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
- # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
- { # Represents a Google Tag Manager Parameter.
- "map": [ # This map parameter's parameters (must have keys; keys must be unique).
- # Object with schema name: Parameter
- ],
- "list": [ # This list parameter's parameters (keys will be ignored).
- # Object with schema name: Parameter
- ],
- "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
- "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
- "type": "A String", # The parameter type. Valid values are:
- # - boolean: The value represents a boolean, represented as 'true' or 'false'
- # - integer: The value represents a 64-bit signed integer value, in base 10
- # - list: A list of parameters should be specified
- # - map: A map of parameters should be specified
- # - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
- },
- ],
- },
- ],
- "containerId": "A String", # GTM Container ID.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="delete">delete(accountId, containerId, ruleId)</code>
- <pre>Deletes a GTM Rule.
-
-Args:
- accountId: string, The GTM Account ID. (required)
- containerId: string, The GTM Container ID. (required)
- ruleId: string, The GTM Rule ID. (required)
-</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(accountId, containerId, ruleId)</code>
- <pre>Gets a GTM Rule.
-
-Args:
- accountId: string, The GTM Account ID. (required)
- containerId: string, The GTM Container ID. (required)
- ruleId: string, The GTM Rule ID. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a Google Tag Manager Rule.
- "name": "A String", # Rule display name.
- "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
- "notes": "A String", # User notes on how to apply this rule in the container.
- "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
- "accountId": "A String", # GTM Account ID.
- "condition": [ # The list of conditions that make up this rule (implicit AND between them).
- { # Represents a predicate.
- "type": "A String", # The type of operator for this condition.
- "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
- # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
- # - At this time, the left operand (arg0) must be a reference to a macro.
- # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
- # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
- { # Represents a Google Tag Manager Parameter.
- "map": [ # This map parameter's parameters (must have keys; keys must be unique).
- # Object with schema name: Parameter
- ],
- "list": [ # This list parameter's parameters (keys will be ignored).
- # Object with schema name: Parameter
- ],
- "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
- "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
- "type": "A String", # The parameter type. Valid values are:
- # - boolean: The value represents a boolean, represented as 'true' or 'false'
- # - integer: The value represents a 64-bit signed integer value, in base 10
- # - list: A list of parameters should be specified
- # - map: A map of parameters should be specified
- # - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
- },
- ],
- },
- ],
- "containerId": "A String", # GTM Container ID.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="list">list(accountId, containerId)</code>
- <pre>Lists all GTM Rules of a Container.
-
-Args:
- accountId: string, The GTM Account ID. (required)
- containerId: string, The GTM Container ID. (required)
-
-Returns:
- An object of the form:
-
- { # List Rules Response.
- "rules": [ # All GTM Rules of a GTM Container.
- { # Represents a Google Tag Manager Rule.
- "name": "A String", # Rule display name.
- "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
- "notes": "A String", # User notes on how to apply this rule in the container.
- "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
- "accountId": "A String", # GTM Account ID.
- "condition": [ # The list of conditions that make up this rule (implicit AND between them).
- { # Represents a predicate.
- "type": "A String", # The type of operator for this condition.
- "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
- # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
- # - At this time, the left operand (arg0) must be a reference to a macro.
- # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
- # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
- { # Represents a Google Tag Manager Parameter.
- "map": [ # This map parameter's parameters (must have keys; keys must be unique).
- # Object with schema name: Parameter
- ],
- "list": [ # This list parameter's parameters (keys will be ignored).
- # Object with schema name: Parameter
- ],
- "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
- "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
- "type": "A String", # The parameter type. Valid values are:
- # - boolean: The value represents a boolean, represented as 'true' or 'false'
- # - integer: The value represents a 64-bit signed integer value, in base 10
- # - list: A list of parameters should be specified
- # - map: A map of parameters should be specified
- # - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
- },
- ],
- },
- ],
- "containerId": "A String", # GTM Container ID.
- },
- ],
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(accountId, containerId, ruleId, body, fingerprint=None)</code>
- <pre>Updates a GTM Rule.
-
-Args:
- accountId: string, The GTM Account ID. (required)
- containerId: string, The GTM Container ID. (required)
- ruleId: string, The GTM Rule ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Google Tag Manager Rule.
- "name": "A String", # Rule display name.
- "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
- "notes": "A String", # User notes on how to apply this rule in the container.
- "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
- "accountId": "A String", # GTM Account ID.
- "condition": [ # The list of conditions that make up this rule (implicit AND between them).
- { # Represents a predicate.
- "type": "A String", # The type of operator for this condition.
- "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
- # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
- # - At this time, the left operand (arg0) must be a reference to a macro.
- # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
- # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
- { # Represents a Google Tag Manager Parameter.
- "map": [ # This map parameter's parameters (must have keys; keys must be unique).
- # Object with schema name: Parameter
- ],
- "list": [ # This list parameter's parameters (keys will be ignored).
- # Object with schema name: Parameter
- ],
- "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
- "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
- "type": "A String", # The parameter type. Valid values are:
- # - boolean: The value represents a boolean, represented as 'true' or 'false'
- # - integer: The value represents a 64-bit signed integer value, in base 10
- # - list: A list of parameters should be specified
- # - map: A map of parameters should be specified
- # - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
- },
- ],
- },
- ],
- "containerId": "A String", # GTM Container ID.
- }
-
- fingerprint: string, When provided, this fingerprint must match the fingerprint of the rule in storage.
-
-Returns:
- An object of the form:
-
- { # Represents a Google Tag Manager Rule.
- "name": "A String", # Rule display name.
- "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule.
- "notes": "A String", # User notes on how to apply this rule in the container.
- "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified.
- "accountId": "A String", # GTM Account ID.
- "condition": [ # The list of conditions that make up this rule (implicit AND between them).
- { # Represents a predicate.
- "type": "A String", # The type of operator for this condition.
- "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes:
- # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively.
- # - At this time, the left operand (arg0) must be a reference to a macro.
- # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive.
- # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
- { # Represents a Google Tag Manager Parameter.
- "map": [ # This map parameter's parameters (must have keys; keys must be unique).
- # Object with schema name: Parameter
- ],
- "list": [ # This list parameter's parameters (keys will be ignored).
- # Object with schema name: Parameter
- ],
- "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
- "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
- "type": "A String", # The parameter type. Valid values are:
- # - boolean: The value represents a boolean, represented as 'true' or 'false'
- # - integer: The value represents a 64-bit signed integer value, in base 10
- # - list: A list of parameters should be specified
- # - map: A map of parameters should be specified
- # - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
- },
- ],
- },
- ],
- "containerId": "A String", # GTM Container ID.
- }</pre>
-</div>
-
-</body></html>
\ No newline at end of file
diff --git a/docs/dyn/manager_v1beta2.html b/docs/dyn/taskqueue_v1beta1.html
similarity index 85%
copy from docs/dyn/manager_v1beta2.html
copy to docs/dyn/taskqueue_v1beta1.html
index 44fc028..f997bde 100644
--- a/docs/dyn/manager_v1beta2.html
+++ b/docs/dyn/taskqueue_v1beta1.html
@@ -72,17 +72,17 @@
</style>
-<h1><a href="manager_v1beta2.html">Deployment Manager API</a></h1>
+<h1><a href="taskqueue_v1beta1.html">TaskQueue API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="manager_v1beta2.deployments.html">deployments()</a></code>
+ <code><a href="taskqueue_v1beta1.taskqueues.html">taskqueues()</a></code>
</p>
-<p class="firstline">Returns the deployments Resource.</p>
+<p class="firstline">Returns the taskqueues Resource.</p>
<p class="toc_element">
- <code><a href="manager_v1beta2.templates.html">templates()</a></code>
+ <code><a href="taskqueue_v1beta1.tasks.html">tasks()</a></code>
</p>
-<p class="firstline">Returns the templates Resource.</p>
+<p class="firstline">Returns the tasks Resource.</p>
<p class="toc_element">
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
diff --git a/docs/dyn/taskqueue_v1beta1.taskqueues.html b/docs/dyn/taskqueue_v1beta1.taskqueues.html
new file mode 100644
index 0000000..ffc8e32
--- /dev/null
+++ b/docs/dyn/taskqueue_v1beta1.taskqueues.html
@@ -0,0 +1,117 @@
+<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="taskqueue_v1beta1.html">TaskQueue API</a> . <a href="taskqueue_v1beta1.taskqueues.html">taskqueues</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(project, taskqueue, getStats=None)</a></code></p>
+<p class="firstline">Get detailed information about a TaskQueue.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(project, taskqueue, getStats=None)</code>
+ <pre>Get detailed information about a TaskQueue.
+
+Args:
+ project: string, The project under which the queue lies. (required)
+ taskqueue: string, The id of the taskqueue to get the properties of. (required)
+ getStats: boolean, Whether to get stats. Optional.
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "taskqueues#taskqueue", # The kind of REST object returned, in this case taskqueue.
+ "stats": { # Statistics for the TaskQueue object in question.
+ "oldestTask": "A String", # The timestamp (in seconds since the epoch) of the oldest unfinished task.
+ "leasedLastMinute": "A String", # Number of tasks leased in the last minute.
+ "totalTasks": 42, # Number of tasks in the queue.
+ "leasedLastHour": "A String", # Number of tasks leased in the last hour.
+ },
+ "id": "A String", # Name of the taskqueue.
+ "maxLeases": 42, # The number of times we should lease out tasks before giving up on them. If unset we lease them out forever until a worker deletes the task.
+ "acl": { # ACLs that are applicable to this TaskQueue object.
+ "consumerEmails": [ # Email addresses of users who can "consume" tasks from the TaskQueue. This means they can Dequeue and Delete tasks from the queue.
+ "A String",
+ ],
+ "producerEmails": [ # Email addresses of users who can "produce" tasks into the TaskQueue. This means they can Insert tasks into the queue.
+ "A String",
+ ],
+ "adminEmails": [ # Email addresses of users who are "admins" of the TaskQueue. This means they can control the queue, eg set ACLs for the queue.
+ "A String",
+ ],
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/taskqueue_v1beta1.tasks.html b/docs/dyn/taskqueue_v1beta1.tasks.html
new file mode 100644
index 0000000..9abaaaf
--- /dev/null
+++ b/docs/dyn/taskqueue_v1beta1.tasks.html
@@ -0,0 +1,177 @@
+<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="taskqueue_v1beta1.html">TaskQueue API</a> . <a href="taskqueue_v1beta1.tasks.html">tasks</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, taskqueue, task)</a></code></p>
+<p class="firstline">Delete a task from a TaskQueue.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, taskqueue, task)</a></code></p>
+<p class="firstline">Get a particular task from a TaskQueue.</p>
+<p class="toc_element">
+ <code><a href="#lease">lease(project, taskqueue, numTasks, leaseSecs)</a></code></p>
+<p class="firstline">Lease 1 or more tasks from a TaskQueue.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, taskqueue)</a></code></p>
+<p class="firstline">List Tasks in a TaskQueue</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, taskqueue, task)</code>
+ <pre>Delete a task from a TaskQueue.
+
+Args:
+ project: string, The project under which the queue lies. (required)
+ taskqueue: string, The taskqueue to delete a task from. (required)
+ task: string, The id of the task to delete. (required)
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, taskqueue, task)</code>
+ <pre>Get a particular task from a TaskQueue.
+
+Args:
+ project: string, The project under which the queue lies. (required)
+ taskqueue: string, The taskqueue in which the task belongs. (required)
+ task: string, The task to get properties of. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
+ "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
+ "id": "A String", # Name of the task.
+ "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
+ "queueName": "A String", # Name of the queue that the task is in.
+ "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="lease">lease(project, taskqueue, numTasks, leaseSecs)</code>
+ <pre>Lease 1 or more tasks from a TaskQueue.
+
+Args:
+ project: string, The project under which the queue lies. (required)
+ taskqueue: string, The taskqueue to lease a task from. (required)
+ numTasks: integer, The number of tasks to lease. (required)
+ leaseSecs: integer, The lease in seconds. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "items": [ # The actual list of tasks returned as a result of the lease operation.
+ {
+ "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
+ "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
+ "id": "A String", # Name of the task.
+ "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
+ "queueName": "A String", # Name of the queue that the task is in.
+ "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
+ },
+ ],
+ "kind": "taskqueue#tasks", # The kind of object returned, a list of tasks.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, taskqueue)</code>
+ <pre>List Tasks in a TaskQueue
+
+Args:
+ project: string, The project under which the queue lies. (required)
+ taskqueue: string, The id of the taskqueue to list tasks from. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "items": [ # The actual list of tasks currently active in the TaskQueue.
+ {
+ "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
+ "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
+ "id": "A String", # Name of the task.
+ "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
+ "queueName": "A String", # Name of the queue that the task is in.
+ "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
+ },
+ ],
+ "kind": "taskqueues#tasks", # The kind of object returned, a list of tasks.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/youtubeAnalytics_v1beta1.batchReportDefinitions.html b/docs/dyn/youtubeAnalytics_v1beta1.batchReportDefinitions.html
new file mode 100644
index 0000000..8dc116c
--- /dev/null
+++ b/docs/dyn/youtubeAnalytics_v1beta1.batchReportDefinitions.html
@@ -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="youtubeAnalytics_v1beta1.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v1beta1.batchReportDefinitions.html">batchReportDefinitions</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(onBehalfOfContentOwner)</a></code></p>
+<p class="firstline">Retrieves a list of available batch report definitions.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(onBehalfOfContentOwner)</code>
+ <pre>Retrieves a list of available batch report definitions.
+
+Args:
+ onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. (required)
+
+Returns:
+ An object of the form:
+
+ { # A paginated list of batchReportDefinition resources returned in response to a youtubeAnalytics.batchReportDefinitions.list request.
+ "items": [ # A list of batchReportDefinition resources that match the request criteria.
+ { # Contains single batchReportDefinition resource.
+ "status": "A String", # Status of the report definition.
+ "kind": "youtubeAnalytics#batchReportDefinition", # This value specifies the type of data of this item. For batch report definition the kind property value is youtubeAnalytics#batchReportDefinition.
+ "type": "A String", # Type of the report definition.
+ "id": "A String", # The ID that YouTube assigns and uses to uniquely identify the report definition.
+ "name": "A String", # Name of the report definition.
+ },
+ ],
+ "kind": "youtubeAnalytics#batchReportDefinitionList", # This value specifies the type of data included in the API response. For the list method, the kind property value is youtubeAnalytics#batchReportDefinitionList.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/youtubeAnalytics_v1beta1.batchReports.html b/docs/dyn/youtubeAnalytics_v1beta1.batchReports.html
new file mode 100644
index 0000000..faa181b
--- /dev/null
+++ b/docs/dyn/youtubeAnalytics_v1beta1.batchReports.html
@@ -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="youtubeAnalytics_v1beta1.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v1beta1.batchReports.html">batchReports</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(batchReportDefinitionId, onBehalfOfContentOwner)</a></code></p>
+<p class="firstline">Retrieves a list of processed batch reports.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(batchReportDefinitionId, onBehalfOfContentOwner)</code>
+ <pre>Retrieves a list of processed batch reports.
+
+Args:
+ batchReportDefinitionId: string, The batchReportDefinitionId parameter specifies the ID of the batch reportort definition for which you are retrieving reports. (required)
+ onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. (required)
+
+Returns:
+ An object of the form:
+
+ { # A paginated list of batchReport resources returned in response to a youtubeAnalytics.batchReport.list request.
+ "items": [ # A list of batchReport resources that match the request criteria.
+ { # Contains single batchReport resource.
+ "kind": "youtubeAnalytics#batchReport", # This value specifies the type of data of this item. For batch report the kind property value is youtubeAnalytics#batchReport.
+ "timeSpan": { # Period included in the report. For reports containing all entities endTime is not set. Both startTime and endTime are inclusive.
+ "endTime": "A String", # End of the period included in the report. Inclusive. For reports containing all entities endTime is not set.
+ "startTime": "A String", # Start of the period included in the report. Inclusive.
+ },
+ "outputs": [ # Report outputs.
+ {
+ "downloadUrl": "A String", # Cloud storage URL to download this report. This URL is valid for 30 minutes.
+ "type": "cloudStorageOutput", # Type of the output.
+ "format": "A String", # Format of the output.
+ },
+ ],
+ "reportId": "A String", # The ID of the the report definition.
+ "timeUpdated": "A String", # The time when the report was updated.
+ "id": "A String", # The ID that YouTube assigns and uses to uniquely identify the report.
+ },
+ ],
+ "kind": "youtubeAnalytics#batchReportList", # This value specifies the type of data included in the API response. For the list method, the kind property value is youtubeAnalytics#batchReportList.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/youtubeAnalytics_v1beta1.groupItems.html b/docs/dyn/youtubeAnalytics_v1beta1.groupItems.html
new file mode 100644
index 0000000..cb1bf01
--- /dev/null
+++ b/docs/dyn/youtubeAnalytics_v1beta1.groupItems.html
@@ -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="youtubeAnalytics_v1beta1.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v1beta1.groupItems.html">groupItems</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(id, onBehalfOfContentOwner=None)</a></code></p>
+<p class="firstline">Removes an item from a group.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(body, onBehalfOfContentOwner=None)</a></code></p>
+<p class="firstline">Creates a group item.</p>
+<p class="toc_element">
+ <code><a href="#list">list(groupId, onBehalfOfContentOwner=None)</a></code></p>
+<p class="firstline">Returns a collection of group items that match the API request parameters.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None)</code>
+ <pre>Removes an item from a group.
+
+Args:
+ id: string, The id parameter specifies the YouTube group item ID for the group that is being deleted. (required)
+ onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
+
+The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(body, onBehalfOfContentOwner=None)</code>
+ <pre>Creates a group item.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "kind": "youtube#groupItem",
+ "etag": "A String",
+ "resource": {
+ "kind": "A String",
+ "id": "A String",
+ },
+ "groupId": "A String",
+ "id": "A String",
+ }
+
+ onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
+
+The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "youtube#groupItem",
+ "etag": "A String",
+ "resource": {
+ "kind": "A String",
+ "id": "A String",
+ },
+ "groupId": "A String",
+ "id": "A String",
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(groupId, onBehalfOfContentOwner=None)</code>
+ <pre>Returns a collection of group items that match the API request parameters.
+
+Args:
+ groupId: string, The id parameter specifies the unique ID of the group for which you want to retrieve group items. (required)
+ onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
+
+The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+
+Returns:
+ An object of the form:
+
+ { # A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.
+ "items": [
+ {
+ "kind": "youtube#groupItem",
+ "etag": "A String",
+ "resource": {
+ "kind": "A String",
+ "id": "A String",
+ },
+ "groupId": "A String",
+ "id": "A String",
+ },
+ ],
+ "kind": "youtube#groupItemListResponse",
+ "etag": "A String",
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/youtubeAnalytics_v1beta1.groups.html b/docs/dyn/youtubeAnalytics_v1beta1.groups.html
new file mode 100644
index 0000000..49743ff
--- /dev/null
+++ b/docs/dyn/youtubeAnalytics_v1beta1.groups.html
@@ -0,0 +1,244 @@
+<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="youtubeAnalytics_v1beta1.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v1beta1.groups.html">groups</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(id, onBehalfOfContentOwner=None)</a></code></p>
+<p class="firstline">Deletes a group.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(body, onBehalfOfContentOwner=None)</a></code></p>
+<p class="firstline">Creates a group.</p>
+<p class="toc_element">
+ <code><a href="#list">list(onBehalfOfContentOwner=None, pageToken=None, mine=None, id=None)</a></code></p>
+<p class="firstline">Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.</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="#update">update(body, onBehalfOfContentOwner=None)</a></code></p>
+<p class="firstline">Modifies a group. For example, you could change a group's title.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None)</code>
+ <pre>Deletes a group.
+
+Args:
+ id: string, The id parameter specifies the YouTube group ID for the group that is being deleted. (required)
+ onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
+
+The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(body, onBehalfOfContentOwner=None)</code>
+ <pre>Creates a group.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "snippet": {
+ "publishedAt": "A String",
+ "title": "A String",
+ },
+ "contentDetails": {
+ "itemCount": "A String",
+ "itemType": "A String",
+ },
+ "kind": "youtube#group",
+ "etag": "A String",
+ "id": "A String",
+ }
+
+ onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
+
+The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+
+Returns:
+ An object of the form:
+
+ {
+ "snippet": {
+ "publishedAt": "A String",
+ "title": "A String",
+ },
+ "contentDetails": {
+ "itemCount": "A String",
+ "itemType": "A String",
+ },
+ "kind": "youtube#group",
+ "etag": "A String",
+ "id": "A String",
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(onBehalfOfContentOwner=None, pageToken=None, mine=None, id=None)</code>
+ <pre>Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.
+
+Args:
+ onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
+
+The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+ pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved.
+ mine: boolean, Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user.
+ id: string, The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID.
+
+Returns:
+ An object of the form:
+
+ { # A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.
+ "nextPageToken": "A String",
+ "items": [
+ {
+ "snippet": {
+ "publishedAt": "A String",
+ "title": "A String",
+ },
+ "contentDetails": {
+ "itemCount": "A String",
+ "itemType": "A String",
+ },
+ "kind": "youtube#group",
+ "etag": "A String",
+ "id": "A String",
+ },
+ ],
+ "kind": "youtube#groupListResponse",
+ "etag": "A String",
+ }</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="update">update(body, onBehalfOfContentOwner=None)</code>
+ <pre>Modifies a group. For example, you could change a group's title.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "snippet": {
+ "publishedAt": "A String",
+ "title": "A String",
+ },
+ "contentDetails": {
+ "itemCount": "A String",
+ "itemType": "A String",
+ },
+ "kind": "youtube#group",
+ "etag": "A String",
+ "id": "A String",
+ }
+
+ onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
+
+The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+
+Returns:
+ An object of the form:
+
+ {
+ "snippet": {
+ "publishedAt": "A String",
+ "title": "A String",
+ },
+ "contentDetails": {
+ "itemCount": "A String",
+ "itemType": "A String",
+ },
+ "kind": "youtube#group",
+ "etag": "A String",
+ "id": "A String",
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/gan_v1beta1.html b/docs/dyn/youtubeAnalytics_v1beta1.html
similarity index 73%
copy from docs/dyn/gan_v1beta1.html
copy to docs/dyn/youtubeAnalytics_v1beta1.html
index a51a20f..0e3e33a 100644
--- a/docs/dyn/gan_v1beta1.html
+++ b/docs/dyn/youtubeAnalytics_v1beta1.html
@@ -72,35 +72,30 @@
</style>
-<h1><a href="gan_v1beta1.html">Google Affiliate Network API</a></h1>
+<h1><a href="youtubeAnalytics_v1beta1.html">YouTube Analytics API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="gan_v1beta1.advertisers.html">advertisers()</a></code>
+ <code><a href="youtubeAnalytics_v1beta1.batchReportDefinitions.html">batchReportDefinitions()</a></code>
</p>
-<p class="firstline">Returns the advertisers Resource.</p>
+<p class="firstline">Returns the batchReportDefinitions Resource.</p>
<p class="toc_element">
- <code><a href="gan_v1beta1.ccOffers.html">ccOffers()</a></code>
+ <code><a href="youtubeAnalytics_v1beta1.batchReports.html">batchReports()</a></code>
</p>
-<p class="firstline">Returns the ccOffers Resource.</p>
+<p class="firstline">Returns the batchReports Resource.</p>
<p class="toc_element">
- <code><a href="gan_v1beta1.events.html">events()</a></code>
+ <code><a href="youtubeAnalytics_v1beta1.groupItems.html">groupItems()</a></code>
</p>
-<p class="firstline">Returns the events Resource.</p>
+<p class="firstline">Returns the groupItems Resource.</p>
<p class="toc_element">
- <code><a href="gan_v1beta1.links.html">links()</a></code>
+ <code><a href="youtubeAnalytics_v1beta1.groups.html">groups()</a></code>
</p>
-<p class="firstline">Returns the links Resource.</p>
+<p class="firstline">Returns the groups Resource.</p>
<p class="toc_element">
- <code><a href="gan_v1beta1.publishers.html">publishers()</a></code>
-</p>
-<p class="firstline">Returns the publishers Resource.</p>
-
-<p class="toc_element">
- <code><a href="gan_v1beta1.reports.html">reports()</a></code>
+ <code><a href="youtubeAnalytics_v1beta1.reports.html">reports()</a></code>
</p>
<p class="firstline">Returns the reports Resource.</p>
diff --git a/docs/dyn/youtubeAnalytics_v1beta1.reports.html b/docs/dyn/youtubeAnalytics_v1beta1.reports.html
new file mode 100644
index 0000000..312da1c
--- /dev/null
+++ b/docs/dyn/youtubeAnalytics_v1beta1.reports.html
@@ -0,0 +1,119 @@
+<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="youtubeAnalytics_v1beta1.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v1beta1.reports.html">reports</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#query">query(ids=None, start_date, end_date, metrics, sort=None, dimensions=None, currency=None, filters=None, max_results=None, start_index=None)</a></code></p>
+<p class="firstline">Retrieve your YouTube Analytics reports.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="query">query(ids=None, start_date, end_date, metrics, sort=None, dimensions=None, currency=None, filters=None, max_results=None, start_index=None)</code>
+ <pre>Retrieve your YouTube Analytics reports.
+
+Args:
+ ids: string, Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data.
+- To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID.
+- To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner. (required)
+ start_date: string, The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. (required)
+ end_date: string, The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. (required)
+ metrics: string, A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics. (required)
+ sort: string, A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '-' prefix causes descending sort order.
+ dimensions: string, A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions.
+ currency: string, The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.
+ filters: string, A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts the result set to include data for the given video in Italy.
+ max_results: integer, The maximum number of rows to include in the 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 (one-based, inclusive).
+
+Returns:
+ An object of the form:
+
+ { # Contains a single result table. The table is returned as an array of rows that contain the values for the cells of the table. Depending on the metric or dimension, the cell can contain a string (video ID, country code) or a number (number of views or number of likes).
+ "kind": "youtubeAnalytics#resultTable", # This value specifies the type of data included in the API response. For the query method, the kind property value will be youtubeAnalytics#resultTable.
+ "rows": [ # The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the columnHeaders field. If no data is available for the given query, the rows element will be omitted from the response. The response for a query with the day dimension will not contain rows for the most recent days.
+ [
+ "",
+ ],
+ ],
+ "columnHeaders": [ # This value specifies information about the data returned in the rows fields. Each item in the columnHeaders list identifies a field returned in the rows value, which contains a list of comma-delimited data. The columnHeaders list will begin with the dimensions specified in the API request, which will be followed by the metrics specified in the API request. The order of both dimensions and metrics will match the ordering in the API request. For example, if the API request contains the parameters dimensions=ageGroup,gender&metrics=viewerPercentage, the API response will return columns in this order: ageGroup,gender,viewerPercentage.
+ {
+ "dataType": "A String", # The type of the data in the column (STRING, INTEGER, FLOAT, etc.).
+ "columnType": "A String", # The type of the column (DIMENSION or METRIC).
+ "name": "A String", # The name of the dimension or metric.
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/epy/class-tree.html b/docs/epy/class-tree.html
index ae26e2a..24a9040 100644
--- a/docs/epy/class-tree.html
+++ b/docs/epy/class-tree.html
@@ -163,7 +163,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient-module.html b/docs/epy/googleapiclient-module.html
index f509c58..956b224 100644
--- a/docs/epy/googleapiclient-module.html
+++ b/docs/epy/googleapiclient-module.html
@@ -57,7 +57,7 @@
<h1 class="epydoc">Package googleapiclient</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient-pysrc.html">source code</a></span></p>
<hr />
<div class="fields"> <p><strong>Version:</strong>
- 1.5.3
+ 1.5.4
</p>
</div><!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
@@ -148,7 +148,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient-pysrc.html b/docs/epy/googleapiclient-pysrc.html
index 19d64cd..9300880 100644
--- a/docs/epy/googleapiclient-pysrc.html
+++ b/docs/epy/googleapiclient-pysrc.html
@@ -69,7 +69,7 @@
<a name="L12"></a><tt class="py-lineno">12</tt> <tt class="py-line"><tt class="py-comment"># See the License for the specific language governing permissions and</tt> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt> <tt class="py-line"><tt class="py-comment"># limitations under the License.</tt> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"> </tt>
-<a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"><tt class="py-name">__version__</tt> <tt class="py-op">=</tt> <tt class="py-docstring">"1.5.3"</tt> </tt>
+<a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"><tt class="py-name">__version__</tt> <tt class="py-op">=</tt> <tt class="py-docstring">"1.5.4"</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt> <tt class="py-line"><tt class="py-comment"># Set default logging handler to avoid "No handler found" warnings.</tt> </tt>
<a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">logging</tt> </tt>
@@ -115,7 +115,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.NullHandler-class.html b/docs/epy/googleapiclient.NullHandler-class.html
index a90c1fa..de6b961 100644
--- a/docs/epy/googleapiclient.NullHandler-class.html
+++ b/docs/epy/googleapiclient.NullHandler-class.html
@@ -58,27 +58,27 @@
<h1 class="epydoc">Class NullHandler</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient-pysrc.html#NullHandler">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap" name="uml_class_diagram_for_googleap">
-<area shape="rect" id="node1_18" href="googleapiclient.NullHandler-class.html#emit" title="Do whatever it takes to actually log the specified logging record." alt="" coords="54,460,159,479"/>
-<area shape="rect" id="node1" href="googleapiclient.NullHandler-class.html" title="googleapiclient.NullHandler" alt="" coords="41,429,171,485"/>
-<area shape="rect" id="node2_19" href="javascript:void(0);" title="logging.Handler.name" alt="" coords="18,140,195,159"/>
-<area shape="rect" id="node2_20" href="javascript:void(0);" title="Initializes the instance - basically setting the formatter to None and the filter list to empty." alt="" coords="18,161,195,180"/>
-<area shape="rect" id="node2_21" href="javascript:void(0);" title="logging.Handler.get_name" alt="" coords="18,180,195,199"/>
-<area shape="rect" id="node2_22" href="javascript:void(0);" title="logging.Handler.set_name" alt="" coords="18,199,195,217"/>
-<area shape="rect" id="node2_23" href="javascript:void(0);" title="Acquire a thread lock for serializing access to the underlying I/O." alt="" coords="18,217,195,236"/>
-<area shape="rect" id="node2_24" href="javascript:void(0);" title="Acquire the I/O thread lock." alt="" coords="18,236,195,255"/>
-<area shape="rect" id="node2_25" href="javascript:void(0);" title="Release the I/O thread lock." alt="" coords="18,255,195,273"/>
-<area shape="rect" id="node2_26" href="javascript:void(0);" title="Set the logging level of this handler." alt="" coords="18,273,195,292"/>
-<area shape="rect" id="node2_27" href="javascript:void(0);" title="Format the specified record." alt="" coords="18,292,195,311"/>
-<area shape="rect" id="node2_28" href="javascript:void(0);" title="Conditionally emit the specified logging record." alt="" coords="18,311,195,329"/>
-<area shape="rect" id="node2_29" href="javascript:void(0);" title="Set the formatter for this handler." alt="" coords="18,329,195,348"/>
-<area shape="rect" id="node2_30" href="javascript:void(0);" title="Ensure all logging output has been flushed." alt="" coords="18,348,195,367"/>
-<area shape="rect" id="node2_31" href="javascript:void(0);" title="Tidy up any resources used by the handler." alt="" coords="18,367,195,385"/>
-<area shape="rect" id="node2_32" href="javascript:void(0);" title="Handle errors which occur during an emit() call." alt="" coords="18,385,195,404"/>
-<area shape="rect" id="node2" href="javascript:void(0);" title="Handler instances dispatch logging events to specific destinations." alt="" coords="5,117,207,411"/>
-<area shape="rect" id="node3_33" href="javascript:void(0);" title="Add the specified filter to this handler." alt="" coords="37,36,178,55"/>
-<area shape="rect" id="node3_34" href="javascript:void(0);" title="Remove the specified filter from this handler." alt="" coords="37,55,178,73"/>
-<area shape="rect" id="node3_35" href="javascript:void(0);" title="Determine if a record is loggable by consulting all the filters." alt="" coords="37,73,178,92"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="A base class for loggers and handlers which allows them to share common code." alt="" coords="25,5,190,99"/>
+<area shape="rect" id="node1_18" href="googleapiclient.NullHandler-class.html#emit" title="Do whatever it takes to actually log the specified logging record." alt="" coords="53,493,159,513"/>
+<area shape="rect" id="node1" href="googleapiclient.NullHandler-class.html" title="googleapiclient.NullHandler" alt="" coords="41,459,170,519"/>
+<area shape="rect" id="node2_19" href="javascript:void(0);" title="logging.Handler.name" alt="" coords="17,151,196,171"/>
+<area shape="rect" id="node2_20" href="javascript:void(0);" title="Initializes the instance - basically setting the formatter to None and the filter list to empty." alt="" coords="17,173,196,193"/>
+<area shape="rect" id="node2_21" href="javascript:void(0);" title="logging.Handler.get_name" alt="" coords="17,193,196,213"/>
+<area shape="rect" id="node2_22" href="javascript:void(0);" title="logging.Handler.set_name" alt="" coords="17,213,196,233"/>
+<area shape="rect" id="node2_23" href="javascript:void(0);" title="Acquire a thread lock for serializing access to the underlying I/O." alt="" coords="17,233,196,253"/>
+<area shape="rect" id="node2_24" href="javascript:void(0);" title="Acquire the I/O thread lock." alt="" coords="17,253,196,273"/>
+<area shape="rect" id="node2_25" href="javascript:void(0);" title="Release the I/O thread lock." alt="" coords="17,273,196,293"/>
+<area shape="rect" id="node2_26" href="javascript:void(0);" title="Set the logging level of this handler." alt="" coords="17,293,196,313"/>
+<area shape="rect" id="node2_27" href="javascript:void(0);" title="Format the specified record." alt="" coords="17,313,196,333"/>
+<area shape="rect" id="node2_28" href="javascript:void(0);" title="Conditionally emit the specified logging record." alt="" coords="17,333,196,353"/>
+<area shape="rect" id="node2_29" href="javascript:void(0);" title="Set the formatter for this handler." alt="" coords="17,353,196,373"/>
+<area shape="rect" id="node2_30" href="javascript:void(0);" title="Ensure all logging output has been flushed." alt="" coords="17,373,196,393"/>
+<area shape="rect" id="node2_31" href="javascript:void(0);" title="Tidy up any resources used by the handler." alt="" coords="17,393,196,413"/>
+<area shape="rect" id="node2_32" href="javascript:void(0);" title="Handle errors which occur during an emit() call." alt="" coords="17,413,196,433"/>
+<area shape="rect" id="node2" href="javascript:void(0);" title="Handler instances dispatch logging events to specific destinations." alt="" coords="5,125,208,440"/>
+<area shape="rect" id="node3_33" href="javascript:void(0);" title="Add the specified filter to this handler." alt="" coords="36,40,177,60"/>
+<area shape="rect" id="node3_34" href="javascript:void(0);" title="Remove the specified filter from this handler." alt="" coords="36,60,177,80"/>
+<area shape="rect" id="node3_35" href="javascript:void(0);" title="Determine if a record is loggable by consulting all the filters." alt="" coords="36,80,177,100"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="A base class for loggers and handlers which allows them to share common code." alt="" coords="24,6,189,106"/>
</map>
<img src="uml_class_diagram_for_googleap.gif" alt='' usemap="#uml_class_diagram_for_googleap" ismap="ismap" class="graph-without-title" />
</center>
@@ -284,7 +284,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.channel-module.html b/docs/epy/googleapiclient.channel-module.html
index d6d2b22..865a71c 100644
--- a/docs/epy/googleapiclient.channel-module.html
+++ b/docs/epy/googleapiclient.channel-module.html
@@ -455,7 +455,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.channel-pysrc.html b/docs/epy/googleapiclient.channel-pysrc.html
index 1b8e20d..d03acc7 100644
--- a/docs/epy/googleapiclient.channel-pysrc.html
+++ b/docs/epy/googleapiclient.channel-pysrc.html
@@ -386,7 +386,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.channel.Channel-class.html b/docs/epy/googleapiclient.channel.Channel-class.html
index 5dd62a3..8d200ce 100644
--- a/docs/epy/googleapiclient.channel.Channel-class.html
+++ b/docs/epy/googleapiclient.channel.Channel-class.html
@@ -59,10 +59,10 @@
<h1 class="epydoc">Class Channel</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.channel-pysrc.html#Channel">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_2" name="uml_class_diagram_for_googleap_2">
-<area shape="rect" id="node1_3" href="googleapiclient.channel.Channel-class.html#__init__" title="Create a new Channel." alt="" coords="17,36,633,55"/>
-<area shape="rect" id="node1_4" href="googleapiclient.channel.Channel-class.html#body" title="Build a body from the Channel." alt="" coords="17,55,633,73"/>
-<area shape="rect" id="node1_5" href="googleapiclient.channel.Channel-class.html#update" title="Update a channel with information from the response of watch()." alt="" coords="17,73,633,92"/>
-<area shape="rect" id="node1" href="googleapiclient.channel.Channel-class.html" title="A Channel for notifications." alt="" coords="5,5,645,99"/>
+<area shape="rect" id="node1_3" href="googleapiclient.channel.Channel-class.html#__init__" title="Create a new Channel." alt="" coords="17,40,627,60"/>
+<area shape="rect" id="node1_4" href="googleapiclient.channel.Channel-class.html#body" title="Build a body from the Channel." alt="" coords="17,60,627,80"/>
+<area shape="rect" id="node1_5" href="googleapiclient.channel.Channel-class.html#update" title="Update a channel with information from the response of watch()." alt="" coords="17,80,627,100"/>
+<area shape="rect" id="node1" href="googleapiclient.channel.Channel-class.html" title="A Channel for notifications." alt="" coords="5,6,638,106"/>
</map>
<img src="uml_class_diagram_for_googleap_2.gif" alt='' usemap="#uml_class_diagram_for_googleap_2" ismap="ismap" class="graph-without-title" />
</center>
@@ -376,7 +376,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.channel.Notification-class.html b/docs/epy/googleapiclient.channel.Notification-class.html
index 7011053..b9cfdfb 100644
--- a/docs/epy/googleapiclient.channel.Notification-class.html
+++ b/docs/epy/googleapiclient.channel.Notification-class.html
@@ -59,8 +59,8 @@
<h1 class="epydoc">Class Notification</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.channel-pysrc.html#Notification">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_3" name="uml_class_diagram_for_googleap_3">
-<area shape="rect" id="node1_1" href="googleapiclient.channel.Notification-class.html#__init__" title="Notification constructor." alt="" coords="17,36,407,55"/>
-<area shape="rect" id="node1" href="googleapiclient.channel.Notification-class.html" title="A Notification from a Channel." alt="" coords="5,5,419,61"/>
+<area shape="rect" id="node1_1" href="googleapiclient.channel.Notification-class.html#__init__" title="Notification constructor." alt="" coords="17,40,401,60"/>
+<area shape="rect" id="node1" href="googleapiclient.channel.Notification-class.html" title="A Notification from a Channel." alt="" coords="5,6,413,66"/>
</map>
<img src="uml_class_diagram_for_googleap_3.gif" alt='' usemap="#uml_class_diagram_for_googleap_3" ismap="ismap" class="graph-without-title" />
</center>
@@ -249,7 +249,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery-module.html b/docs/epy/googleapiclient.discovery-module.html
index c5d6334..080b034 100644
--- a/docs/epy/googleapiclient.discovery-module.html
+++ b/docs/epy/googleapiclient.discovery-module.html
@@ -1221,7 +1221,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery-pysrc.html b/docs/epy/googleapiclient.discovery-pysrc.html
index f2dedfd..19be8ee 100644
--- a/docs/epy/googleapiclient.discovery-pysrc.html
+++ b/docs/epy/googleapiclient.discovery-pysrc.html
@@ -119,1221 +119,1223 @@
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-14" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-14', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="googleapiclient.errors" class="py-name" href="#" onclick="return doclink('link-15', 'errors', 'link-3');">errors</a></tt> <tt class="py-keyword">import</tt> <tt id="link-16" class="py-name" targets="Class googleapiclient.errors.UnknownApiNameOrVersion=googleapiclient.errors.UnknownApiNameOrVersion-class.html"><a title="googleapiclient.errors.UnknownApiNameOrVersion" class="py-name" href="#" onclick="return doclink('link-16', 'UnknownApiNameOrVersion', 'link-16');">UnknownApiNameOrVersion</a></tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-17" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-17', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="googleapiclient.errors" class="py-name" href="#" onclick="return doclink('link-18', 'errors', 'link-3');">errors</a></tt> <tt class="py-keyword">import</tt> <tt id="link-19" class="py-name" targets="Class googleapiclient.errors.UnknownFileType=googleapiclient.errors.UnknownFileType-class.html"><a title="googleapiclient.errors.UnknownFileType" class="py-name" href="#" onclick="return doclink('link-19', 'UnknownFileType', 'link-19');">UnknownFileType</a></tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-20" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-20', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-21" class="py-name" targets="Module googleapiclient.http=googleapiclient.http-module.html"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-21', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">import</tt> <tt id="link-22" class="py-name" targets="Class googleapiclient.http.BatchHttpRequest=googleapiclient.http.BatchHttpRequest-class.html"><a title="googleapiclient.http.BatchHttpRequest" class="py-name" href="#" onclick="return doclink('link-22', 'BatchHttpRequest', 'link-22');">BatchHttpRequest</a></tt> </tt>
-<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-23" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-23', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-24" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-24', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">import</tt> <tt id="link-25" class="py-name" targets="Class googleapiclient.http.HttpRequest=googleapiclient.http.HttpRequest-class.html"><a title="googleapiclient.http.HttpRequest" class="py-name" href="#" onclick="return doclink('link-25', 'HttpRequest', 'link-25');">HttpRequest</a></tt> </tt>
-<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-26" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-26', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-27', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">import</tt> <tt id="link-28" class="py-name" targets="Class googleapiclient.http.MediaFileUpload=googleapiclient.http.MediaFileUpload-class.html"><a title="googleapiclient.http.MediaFileUpload" class="py-name" href="#" onclick="return doclink('link-28', 'MediaFileUpload', 'link-28');">MediaFileUpload</a></tt> </tt>
-<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-29" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-29', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-30', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">import</tt> <tt id="link-31" class="py-name" targets="Class googleapiclient.http.MediaUpload=googleapiclient.http.MediaUpload-class.html"><a title="googleapiclient.http.MediaUpload" class="py-name" href="#" onclick="return doclink('link-31', 'MediaUpload', 'link-31');">MediaUpload</a></tt> </tt>
-<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-32" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-32', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-33" class="py-name" targets="Module googleapiclient.model=googleapiclient.model-module.html"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-33', 'model', 'link-33');">model</a></tt> <tt class="py-keyword">import</tt> <tt id="link-34" class="py-name" targets="Class googleapiclient.model.JsonModel=googleapiclient.model.JsonModel-class.html"><a title="googleapiclient.model.JsonModel" class="py-name" href="#" onclick="return doclink('link-34', 'JsonModel', 'link-34');">JsonModel</a></tt> </tt>
-<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-35" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-35', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-36', 'model', 'link-33');">model</a></tt> <tt class="py-keyword">import</tt> <tt id="link-37" class="py-name" targets="Class googleapiclient.model.MediaModel=googleapiclient.model.MediaModel-class.html"><a title="googleapiclient.model.MediaModel" class="py-name" href="#" onclick="return doclink('link-37', 'MediaModel', 'link-37');">MediaModel</a></tt> </tt>
-<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-38" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-38', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-39" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-39', 'model', 'link-33');">model</a></tt> <tt class="py-keyword">import</tt> <tt id="link-40" class="py-name" targets="Class googleapiclient.model.RawModel=googleapiclient.model.RawModel-class.html"><a title="googleapiclient.model.RawModel" class="py-name" href="#" onclick="return doclink('link-40', 'RawModel', 'link-40');">RawModel</a></tt> </tt>
-<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-41" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-41', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-42" class="py-name" targets="Module googleapiclient.schema=googleapiclient.schema-module.html"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-42', 'schema', 'link-42');">schema</a></tt> <tt class="py-keyword">import</tt> <tt id="link-43" class="py-name" targets="Class googleapiclient.schema.Schemas=googleapiclient.schema.Schemas-class.html"><a title="googleapiclient.schema.Schemas" class="py-name" href="#" onclick="return doclink('link-43', 'Schemas', 'link-43');">Schemas</a></tt> </tt>
-<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">client</tt> <tt class="py-keyword">import</tt> <tt class="py-name">GoogleCredentials</tt> </tt>
-<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> </tt>
-<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-comment"># Oauth2client < 3 has the positional helper in 'util', >= 3 has it</tt> </tt>
-<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-comment"># in '_helpers'.</tt> </tt>
-<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
-<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">util</tt> <tt class="py-keyword">import</tt> <tt class="py-name">_add_query_parameter</tt> </tt>
-<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">util</tt> <tt class="py-keyword">import</tt> <tt class="py-name">positional</tt> </tt>
-<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt>
-<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">_helpers</tt> <tt class="py-keyword">import</tt> <tt class="py-name">_add_query_parameter</tt> </tt>
-<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">_helpers</tt> <tt class="py-keyword">import</tt> <tt class="py-name">positional</tt> </tt>
-<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> </tt>
-<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> </tt>
-<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-comment"># The client library requires a version of httplib2 that supports RETRIES.</tt> </tt>
-<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">RETRIES</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
-<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> </tt>
-<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt id="link-44" class="py-name" targets="Variable googleapiclient.discovery.logger=googleapiclient.discovery-module.html#logger"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-44', 'logger', 'link-44');">logger</a></tt> <tt class="py-op">=</tt> <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">getLogger</tt><tt class="py-op">(</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt> </tt>
+<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-23" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-23', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-24" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-24', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">import</tt> <tt id="link-25" class="py-name" targets="Class googleapiclient.http.HttpMock=googleapiclient.http.HttpMock-class.html"><a title="googleapiclient.http.HttpMock" class="py-name" href="#" onclick="return doclink('link-25', 'HttpMock', 'link-25');">HttpMock</a></tt> </tt>
+<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-26" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-26', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-27', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">import</tt> <tt id="link-28" class="py-name" targets="Class googleapiclient.http.HttpMockSequence=googleapiclient.http.HttpMockSequence-class.html"><a title="googleapiclient.http.HttpMockSequence" class="py-name" href="#" onclick="return doclink('link-28', 'HttpMockSequence', 'link-28');">HttpMockSequence</a></tt> </tt>
+<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-29" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-29', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-30', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">import</tt> <tt id="link-31" class="py-name" targets="Class googleapiclient.http.HttpRequest=googleapiclient.http.HttpRequest-class.html"><a title="googleapiclient.http.HttpRequest" class="py-name" href="#" onclick="return doclink('link-31', 'HttpRequest', 'link-31');">HttpRequest</a></tt> </tt>
+<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-32" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-32', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-33', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">import</tt> <tt id="link-34" class="py-name" targets="Class googleapiclient.http.MediaFileUpload=googleapiclient.http.MediaFileUpload-class.html"><a title="googleapiclient.http.MediaFileUpload" class="py-name" href="#" onclick="return doclink('link-34', 'MediaFileUpload', 'link-34');">MediaFileUpload</a></tt> </tt>
+<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-35" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-35', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-36', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">import</tt> <tt id="link-37" class="py-name" targets="Class googleapiclient.http.MediaUpload=googleapiclient.http.MediaUpload-class.html"><a title="googleapiclient.http.MediaUpload" class="py-name" href="#" onclick="return doclink('link-37', 'MediaUpload', 'link-37');">MediaUpload</a></tt> </tt>
+<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-38" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-38', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-39" class="py-name" targets="Module googleapiclient.model=googleapiclient.model-module.html"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-39', 'model', 'link-39');">model</a></tt> <tt class="py-keyword">import</tt> <tt id="link-40" class="py-name" targets="Class googleapiclient.model.JsonModel=googleapiclient.model.JsonModel-class.html"><a title="googleapiclient.model.JsonModel" class="py-name" href="#" onclick="return doclink('link-40', 'JsonModel', 'link-40');">JsonModel</a></tt> </tt>
+<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-41" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-41', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-42" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-42', 'model', 'link-39');">model</a></tt> <tt class="py-keyword">import</tt> <tt id="link-43" class="py-name" targets="Class googleapiclient.model.MediaModel=googleapiclient.model.MediaModel-class.html"><a title="googleapiclient.model.MediaModel" class="py-name" href="#" onclick="return doclink('link-43', 'MediaModel', 'link-43');">MediaModel</a></tt> </tt>
+<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-44" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-44', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-45" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-45', 'model', 'link-39');">model</a></tt> <tt class="py-keyword">import</tt> <tt id="link-46" class="py-name" targets="Class googleapiclient.model.RawModel=googleapiclient.model.RawModel-class.html"><a title="googleapiclient.model.RawModel" class="py-name" href="#" onclick="return doclink('link-46', 'RawModel', 'link-46');">RawModel</a></tt> </tt>
+<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-47" class="py-name"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-47', 'googleapiclient', 'link-0');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-48" class="py-name" targets="Module googleapiclient.schema=googleapiclient.schema-module.html"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-48', 'schema', 'link-48');">schema</a></tt> <tt class="py-keyword">import</tt> <tt id="link-49" class="py-name" targets="Class googleapiclient.schema.Schemas=googleapiclient.schema.Schemas-class.html"><a title="googleapiclient.schema.Schemas" class="py-name" href="#" onclick="return doclink('link-49', 'Schemas', 'link-49');">Schemas</a></tt> </tt>
+<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">client</tt> <tt class="py-keyword">import</tt> <tt class="py-name">GoogleCredentials</tt> </tt>
+<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> </tt>
+<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-comment"># Oauth2client < 3 has the positional helper in 'util', >= 3 has it</tt> </tt>
+<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-comment"># in '_helpers'.</tt> </tt>
+<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
+<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">util</tt> <tt class="py-keyword">import</tt> <tt class="py-name">_add_query_parameter</tt> </tt>
+<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">util</tt> <tt class="py-keyword">import</tt> <tt class="py-name">positional</tt> </tt>
+<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt>
+<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">_helpers</tt> <tt class="py-keyword">import</tt> <tt class="py-name">_add_query_parameter</tt> </tt>
+<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">_helpers</tt> <tt class="py-keyword">import</tt> <tt class="py-name">positional</tt> </tt>
+<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> </tt>
+<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> </tt>
+<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-comment"># The client library requires a version of httplib2 that supports RETRIES.</tt> </tt>
+<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">RETRIES</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> </tt>
-<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt id="link-45" class="py-name" targets="Variable googleapiclient.discovery.URITEMPLATE=googleapiclient.discovery-module.html#URITEMPLATE"><a title="googleapiclient.discovery.URITEMPLATE" class="py-name" href="#" onclick="return doclink('link-45', 'URITEMPLATE', 'link-45');">URITEMPLATE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'{[^}]*}'</tt><tt class="py-op">)</tt> </tt>
-<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt id="link-46" class="py-name" targets="Variable googleapiclient.discovery.VARNAME=googleapiclient.discovery-module.html#VARNAME"><a title="googleapiclient.discovery.VARNAME" class="py-name" href="#" onclick="return doclink('link-46', 'VARNAME', 'link-46');">VARNAME</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'[a-zA-Z0-9_-]+'</tt><tt class="py-op">)</tt> </tt>
-<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt id="link-47" class="py-name" targets="Variable googleapiclient.discovery.DISCOVERY_URI=googleapiclient.discovery-module.html#DISCOVERY_URI"><a title="googleapiclient.discovery.DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-47', 'DISCOVERY_URI', 'link-47');">DISCOVERY_URI</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'https://www.googleapis.com/discovery/v1/apis/'</tt> </tt>
-<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt class="py-string">'{api}/{apiVersion}/rest'</tt><tt class="py-op">)</tt> </tt>
-<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt id="link-48" class="py-name" targets="Variable googleapiclient.discovery.V1_DISCOVERY_URI=googleapiclient.discovery-module.html#V1_DISCOVERY_URI"><a title="googleapiclient.discovery.V1_DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-48', 'V1_DISCOVERY_URI', 'link-48');">V1_DISCOVERY_URI</a></tt> <tt class="py-op">=</tt> <tt id="link-49" class="py-name"><a title="googleapiclient.discovery.DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-49', 'DISCOVERY_URI', 'link-47');">DISCOVERY_URI</a></tt> </tt>
-<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt id="link-50" class="py-name" targets="Variable googleapiclient.discovery.V2_DISCOVERY_URI=googleapiclient.discovery-module.html#V2_DISCOVERY_URI"><a title="googleapiclient.discovery.V2_DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-50', 'V2_DISCOVERY_URI', 'link-50');">V2_DISCOVERY_URI</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'https://{api}.googleapis.com/$discovery/rest?'</tt> </tt>
-<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-string">'version={apiVersion}'</tt><tt class="py-op">)</tt> </tt>
-<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt id="link-51" class="py-name" targets="Variable googleapiclient.discovery.DEFAULT_METHOD_DOC=googleapiclient.discovery-module.html#DEFAULT_METHOD_DOC"><a title="googleapiclient.discovery.DEFAULT_METHOD_DOC" class="py-name" href="#" onclick="return doclink('link-51', 'DEFAULT_METHOD_DOC', 'link-51');">DEFAULT_METHOD_DOC</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'A description of how to use this function'</tt> </tt>
-<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt id="link-52" class="py-name" targets="Variable googleapiclient.discovery.HTTP_PAYLOAD_METHODS=googleapiclient.discovery-module.html#HTTP_PAYLOAD_METHODS"><a title="googleapiclient.discovery.HTTP_PAYLOAD_METHODS" class="py-name" href="#" onclick="return doclink('link-52', 'HTTP_PAYLOAD_METHODS', 'link-52');">HTTP_PAYLOAD_METHODS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">frozenset</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'PUT'</tt><tt class="py-op">,</tt> <tt class="py-string">'POST'</tt><tt class="py-op">,</tt> <tt class="py-string">'PATCH'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt id="link-53" class="py-name" targets="Variable googleapiclient.discovery._MEDIA_SIZE_BIT_SHIFTS=googleapiclient.discovery-module.html#_MEDIA_SIZE_BIT_SHIFTS"><a title="googleapiclient.discovery._MEDIA_SIZE_BIT_SHIFTS" class="py-name" href="#" onclick="return doclink('link-53', '_MEDIA_SIZE_BIT_SHIFTS', 'link-53');">_MEDIA_SIZE_BIT_SHIFTS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'KB'</tt><tt class="py-op">:</tt> <tt class="py-number">10</tt><tt class="py-op">,</tt> <tt class="py-string">'MB'</tt><tt class="py-op">:</tt> <tt class="py-number">20</tt><tt class="py-op">,</tt> <tt class="py-string">'GB'</tt><tt class="py-op">:</tt> <tt class="py-number">30</tt><tt class="py-op">,</tt> <tt class="py-string">'TB'</tt><tt class="py-op">:</tt> <tt class="py-number">40</tt><tt class="py-op">}</tt> </tt>
-<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt id="link-54" class="py-name" targets="Variable googleapiclient.discovery.BODY_PARAMETER_DEFAULT_VALUE=googleapiclient.discovery-module.html#BODY_PARAMETER_DEFAULT_VALUE"><a title="googleapiclient.discovery.BODY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-54', 'BODY_PARAMETER_DEFAULT_VALUE', 'link-54');">BODY_PARAMETER_DEFAULT_VALUE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
-<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-string">'description'</tt><tt class="py-op">:</tt> <tt class="py-string">'The request body.'</tt><tt class="py-op">,</tt> </tt>
-<a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"> <tt class="py-string">'type'</tt><tt class="py-op">:</tt> <tt class="py-string">'object'</tt><tt class="py-op">,</tt> </tt>
-<a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"> <tt class="py-string">'required'</tt><tt class="py-op">:</tt> <tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
-<a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"><tt class="py-op">}</tt> </tt>
-<a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"><tt id="link-55" class="py-name" targets="Variable googleapiclient.discovery.MEDIA_BODY_PARAMETER_DEFAULT_VALUE=googleapiclient.discovery-module.html#MEDIA_BODY_PARAMETER_DEFAULT_VALUE"><a title="googleapiclient.discovery.MEDIA_BODY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-55', 'MEDIA_BODY_PARAMETER_DEFAULT_VALUE', 'link-55');">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
-<a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"> <tt class="py-string">'description'</tt><tt class="py-op">:</tt> <tt class="py-op">(</tt><tt class="py-string">'The filename of the media request body, or an instance '</tt> </tt>
-<a name="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"> <tt class="py-string">'of a MediaUpload object.'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
-<a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"> <tt class="py-string">'type'</tt><tt class="py-op">:</tt> <tt class="py-string">'string'</tt><tt class="py-op">,</tt> </tt>
-<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"> <tt class="py-string">'required'</tt><tt class="py-op">:</tt> <tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
-<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"><tt class="py-op">}</tt> </tt>
-<a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"> </tt>
-<a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"><tt class="py-comment"># Parameters accepted by the stack, but not visible via discovery.</tt> </tt>
-<a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"><tt class="py-comment"># TODO(dhermes): Remove 'userip' in 'v2'.</tt> </tt>
-<a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"><tt id="link-56" class="py-name" targets="Variable googleapiclient.discovery.STACK_QUERY_PARAMETERS=googleapiclient.discovery-module.html#STACK_QUERY_PARAMETERS"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETERS" class="py-name" href="#" onclick="return doclink('link-56', 'STACK_QUERY_PARAMETERS', 'link-56');">STACK_QUERY_PARAMETERS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">frozenset</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'trace'</tt><tt class="py-op">,</tt> <tt class="py-string">'pp'</tt><tt class="py-op">,</tt> <tt class="py-string">'userip'</tt><tt class="py-op">,</tt> <tt class="py-string">'strict'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"><tt id="link-57" class="py-name" targets="Variable googleapiclient.discovery.STACK_QUERY_PARAMETER_DEFAULT_VALUE=googleapiclient.discovery-module.html#STACK_QUERY_PARAMETER_DEFAULT_VALUE"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-57', 'STACK_QUERY_PARAMETER_DEFAULT_VALUE', 'link-57');">STACK_QUERY_PARAMETER_DEFAULT_VALUE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'type'</tt><tt class="py-op">:</tt> <tt class="py-string">'string'</tt><tt class="py-op">,</tt> <tt class="py-string">'location'</tt><tt class="py-op">:</tt> <tt class="py-string">'query'</tt><tt class="py-op">}</tt> </tt>
-<a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"> </tt>
-<a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"><tt class="py-comment"># Library-specific reserved words beyond Python keywords.</tt> </tt>
-<a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"><tt id="link-58" class="py-name" targets="Variable googleapiclient.discovery.RESERVED_WORDS=googleapiclient.discovery-module.html#RESERVED_WORDS"><a title="googleapiclient.discovery.RESERVED_WORDS" class="py-name" href="#" onclick="return doclink('link-58', 'RESERVED_WORDS', 'link-58');">RESERVED_WORDS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">frozenset</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'body'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="_BytesGenerator"></a><div id="_BytesGenerator-def"><a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"> </tt>
-<a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"><tt class="py-comment"># patch _write_lines to avoid munging '\r' into '\n'</tt> </tt>
-<a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"><tt class="py-comment"># ( https://bugs.python.org/issue18886 https://bugs.python.org/issue19003 )</tt> </tt>
-<a name="L120"></a><tt class="py-lineno"> 120</tt> <a class="py-toggle" href="#" id="_BytesGenerator-toggle" onclick="return toggle('_BytesGenerator');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.discovery._BytesGenerator-class.html">_BytesGenerator</a><tt class="py-op">(</tt><tt class="py-base-class">BytesGenerator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="_BytesGenerator-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_BytesGenerator-expanded"><a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"> <tt id="link-59" class="py-name" targets="Variable googleapiclient.discovery._BytesGenerator._write_lines=googleapiclient.discovery._BytesGenerator-class.html#_write_lines"><a title="googleapiclient.discovery._BytesGenerator._write_lines" class="py-name" href="#" onclick="return doclink('link-59', '_write_lines', 'link-59');">_write_lines</a></tt> <tt class="py-op">=</tt> <tt class="py-name">BytesGenerator</tt><tt class="py-op">.</tt><tt class="py-name">write</tt> </tt>
-</div><a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"> </tt>
-<a name="fix_method_name"></a><div id="fix_method_name-def"><a name="L123"></a><tt class="py-lineno"> 123</tt> <a class="py-toggle" href="#" id="fix_method_name-toggle" onclick="return toggle('fix_method_name');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#fix_method_name">fix_method_name</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="fix_method_name-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="fix_method_name-expanded"><a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"> <tt class="py-docstring">"""Fix method names to avoid reserved word conflicts.</tt> </tt>
-<a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"><tt class="py-docstring"> name: string, method name.</tt> </tt>
-<a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"><tt class="py-docstring"> The name with a '_' prefixed if the name is a reserved word.</tt> </tt>
-<a name="L131"></a><tt class="py-lineno"> 131</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">keyword</tt><tt class="py-op">.</tt><tt class="py-name">iskeyword</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt id="link-60" class="py-name"><a title="googleapiclient.discovery.RESERVED_WORDS" class="py-name" href="#" onclick="return doclink('link-60', 'RESERVED_WORDS', 'link-58');">RESERVED_WORDS</a></tt><tt class="py-op">:</tt> </tt>
-<a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">name</tt> <tt class="py-op">+</tt> <tt class="py-string">'_'</tt> </tt>
-<a name="L134"></a><tt class="py-lineno"> 134</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">name</tt> </tt>
-</div><a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"> </tt>
-<a name="key2param"></a><div id="key2param-def"><a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"> </tt>
-<a name="L138"></a><tt class="py-lineno"> 138</tt> <a class="py-toggle" href="#" id="key2param-toggle" onclick="return toggle('key2param');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#key2param">key2param</a><tt class="py-op">(</tt><tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="key2param-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="key2param-expanded"><a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"> <tt class="py-docstring">"""Converts key names into parameter names.</tt> </tt>
-<a name="L140"></a><tt class="py-lineno"> 140</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"><tt class="py-docstring"> For example, converting "max-results" -> "max_results"</tt> </tt>
+<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt id="link-50" class="py-name" targets="Variable googleapiclient.discovery.logger=googleapiclient.discovery-module.html#logger"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-50', 'logger', 'link-50');">logger</a></tt> <tt class="py-op">=</tt> <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">getLogger</tt><tt class="py-op">(</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt> </tt>
+<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> </tt>
+<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt id="link-51" class="py-name" targets="Variable googleapiclient.discovery.URITEMPLATE=googleapiclient.discovery-module.html#URITEMPLATE"><a title="googleapiclient.discovery.URITEMPLATE" class="py-name" href="#" onclick="return doclink('link-51', 'URITEMPLATE', 'link-51');">URITEMPLATE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'{[^}]*}'</tt><tt class="py-op">)</tt> </tt>
+<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt id="link-52" class="py-name" targets="Variable googleapiclient.discovery.VARNAME=googleapiclient.discovery-module.html#VARNAME"><a title="googleapiclient.discovery.VARNAME" class="py-name" href="#" onclick="return doclink('link-52', 'VARNAME', 'link-52');">VARNAME</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'[a-zA-Z0-9_-]+'</tt><tt class="py-op">)</tt> </tt>
+<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt id="link-53" class="py-name" targets="Variable googleapiclient.discovery.DISCOVERY_URI=googleapiclient.discovery-module.html#DISCOVERY_URI"><a title="googleapiclient.discovery.DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-53', 'DISCOVERY_URI', 'link-53');">DISCOVERY_URI</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'https://www.googleapis.com/discovery/v1/apis/'</tt> </tt>
+<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-string">'{api}/{apiVersion}/rest'</tt><tt class="py-op">)</tt> </tt>
+<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt id="link-54" class="py-name" targets="Variable googleapiclient.discovery.V1_DISCOVERY_URI=googleapiclient.discovery-module.html#V1_DISCOVERY_URI"><a title="googleapiclient.discovery.V1_DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-54', 'V1_DISCOVERY_URI', 'link-54');">V1_DISCOVERY_URI</a></tt> <tt class="py-op">=</tt> <tt id="link-55" class="py-name"><a title="googleapiclient.discovery.DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-55', 'DISCOVERY_URI', 'link-53');">DISCOVERY_URI</a></tt> </tt>
+<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt id="link-56" class="py-name" targets="Variable googleapiclient.discovery.V2_DISCOVERY_URI=googleapiclient.discovery-module.html#V2_DISCOVERY_URI"><a title="googleapiclient.discovery.V2_DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-56', 'V2_DISCOVERY_URI', 'link-56');">V2_DISCOVERY_URI</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'https://{api}.googleapis.com/$discovery/rest?'</tt> </tt>
+<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-string">'version={apiVersion}'</tt><tt class="py-op">)</tt> </tt>
+<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt id="link-57" class="py-name" targets="Variable googleapiclient.discovery.DEFAULT_METHOD_DOC=googleapiclient.discovery-module.html#DEFAULT_METHOD_DOC"><a title="googleapiclient.discovery.DEFAULT_METHOD_DOC" class="py-name" href="#" onclick="return doclink('link-57', 'DEFAULT_METHOD_DOC', 'link-57');">DEFAULT_METHOD_DOC</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'A description of how to use this function'</tt> </tt>
+<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt id="link-58" class="py-name" targets="Variable googleapiclient.discovery.HTTP_PAYLOAD_METHODS=googleapiclient.discovery-module.html#HTTP_PAYLOAD_METHODS"><a title="googleapiclient.discovery.HTTP_PAYLOAD_METHODS" class="py-name" href="#" onclick="return doclink('link-58', 'HTTP_PAYLOAD_METHODS', 'link-58');">HTTP_PAYLOAD_METHODS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">frozenset</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'PUT'</tt><tt class="py-op">,</tt> <tt class="py-string">'POST'</tt><tt class="py-op">,</tt> <tt class="py-string">'PATCH'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt id="link-59" class="py-name" targets="Variable googleapiclient.discovery._MEDIA_SIZE_BIT_SHIFTS=googleapiclient.discovery-module.html#_MEDIA_SIZE_BIT_SHIFTS"><a title="googleapiclient.discovery._MEDIA_SIZE_BIT_SHIFTS" class="py-name" href="#" onclick="return doclink('link-59', '_MEDIA_SIZE_BIT_SHIFTS', 'link-59');">_MEDIA_SIZE_BIT_SHIFTS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'KB'</tt><tt class="py-op">:</tt> <tt class="py-number">10</tt><tt class="py-op">,</tt> <tt class="py-string">'MB'</tt><tt class="py-op">:</tt> <tt class="py-number">20</tt><tt class="py-op">,</tt> <tt class="py-string">'GB'</tt><tt class="py-op">:</tt> <tt class="py-number">30</tt><tt class="py-op">,</tt> <tt class="py-string">'TB'</tt><tt class="py-op">:</tt> <tt class="py-number">40</tt><tt class="py-op">}</tt> </tt>
+<a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"><tt id="link-60" class="py-name" targets="Variable googleapiclient.discovery.BODY_PARAMETER_DEFAULT_VALUE=googleapiclient.discovery-module.html#BODY_PARAMETER_DEFAULT_VALUE"><a title="googleapiclient.discovery.BODY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-60', 'BODY_PARAMETER_DEFAULT_VALUE', 'link-60');">BODY_PARAMETER_DEFAULT_VALUE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
+<a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"> <tt class="py-string">'description'</tt><tt class="py-op">:</tt> <tt class="py-string">'The request body.'</tt><tt class="py-op">,</tt> </tt>
+<a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"> <tt class="py-string">'type'</tt><tt class="py-op">:</tt> <tt class="py-string">'object'</tt><tt class="py-op">,</tt> </tt>
+<a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"> <tt class="py-string">'required'</tt><tt class="py-op">:</tt> <tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
+<a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"><tt class="py-op">}</tt> </tt>
+<a name="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"><tt id="link-61" class="py-name" targets="Variable googleapiclient.discovery.MEDIA_BODY_PARAMETER_DEFAULT_VALUE=googleapiclient.discovery-module.html#MEDIA_BODY_PARAMETER_DEFAULT_VALUE"><a title="googleapiclient.discovery.MEDIA_BODY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-61', 'MEDIA_BODY_PARAMETER_DEFAULT_VALUE', 'link-61');">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
+<a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"> <tt class="py-string">'description'</tt><tt class="py-op">:</tt> <tt class="py-op">(</tt><tt class="py-string">'The filename of the media request body, or an instance '</tt> </tt>
+<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"> <tt class="py-string">'of a MediaUpload object.'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
+<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"> <tt class="py-string">'type'</tt><tt class="py-op">:</tt> <tt class="py-string">'string'</tt><tt class="py-op">,</tt> </tt>
+<a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"> <tt class="py-string">'required'</tt><tt class="py-op">:</tt> <tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
+<a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"><tt class="py-op">}</tt> </tt>
+<a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"> </tt>
+<a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"><tt class="py-comment"># Parameters accepted by the stack, but not visible via discovery.</tt> </tt>
+<a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"><tt class="py-comment"># TODO(dhermes): Remove 'userip' in 'v2'.</tt> </tt>
+<a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"><tt id="link-62" class="py-name" targets="Variable googleapiclient.discovery.STACK_QUERY_PARAMETERS=googleapiclient.discovery-module.html#STACK_QUERY_PARAMETERS"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETERS" class="py-name" href="#" onclick="return doclink('link-62', 'STACK_QUERY_PARAMETERS', 'link-62');">STACK_QUERY_PARAMETERS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">frozenset</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'trace'</tt><tt class="py-op">,</tt> <tt class="py-string">'pp'</tt><tt class="py-op">,</tt> <tt class="py-string">'userip'</tt><tt class="py-op">,</tt> <tt class="py-string">'strict'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"><tt id="link-63" class="py-name" targets="Variable googleapiclient.discovery.STACK_QUERY_PARAMETER_DEFAULT_VALUE=googleapiclient.discovery-module.html#STACK_QUERY_PARAMETER_DEFAULT_VALUE"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-63', 'STACK_QUERY_PARAMETER_DEFAULT_VALUE', 'link-63');">STACK_QUERY_PARAMETER_DEFAULT_VALUE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'type'</tt><tt class="py-op">:</tt> <tt class="py-string">'string'</tt><tt class="py-op">,</tt> <tt class="py-string">'location'</tt><tt class="py-op">:</tt> <tt class="py-string">'query'</tt><tt class="py-op">}</tt> </tt>
+<a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"> </tt>
+<a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"><tt class="py-comment"># Library-specific reserved words beyond Python keywords.</tt> </tt>
+<a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"><tt id="link-64" class="py-name" targets="Variable googleapiclient.discovery.RESERVED_WORDS=googleapiclient.discovery-module.html#RESERVED_WORDS"><a title="googleapiclient.discovery.RESERVED_WORDS" class="py-name" href="#" onclick="return doclink('link-64', 'RESERVED_WORDS', 'link-64');">RESERVED_WORDS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">frozenset</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'body'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="_BytesGenerator"></a><div id="_BytesGenerator-def"><a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"> </tt>
+<a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"><tt class="py-comment"># patch _write_lines to avoid munging '\r' into '\n'</tt> </tt>
+<a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"><tt class="py-comment"># ( https://bugs.python.org/issue18886 https://bugs.python.org/issue19003 )</tt> </tt>
+<a name="L122"></a><tt class="py-lineno"> 122</tt> <a class="py-toggle" href="#" id="_BytesGenerator-toggle" onclick="return toggle('_BytesGenerator');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.discovery._BytesGenerator-class.html">_BytesGenerator</a><tt class="py-op">(</tt><tt class="py-base-class">BytesGenerator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="_BytesGenerator-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_BytesGenerator-expanded"><a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"> <tt id="link-65" class="py-name" targets="Variable googleapiclient.discovery._BytesGenerator._write_lines=googleapiclient.discovery._BytesGenerator-class.html#_write_lines"><a title="googleapiclient.discovery._BytesGenerator._write_lines" class="py-name" href="#" onclick="return doclink('link-65', '_write_lines', 'link-65');">_write_lines</a></tt> <tt class="py-op">=</tt> <tt class="py-name">BytesGenerator</tt><tt class="py-op">.</tt><tt class="py-name">write</tt> </tt>
+</div><a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"> </tt>
+<a name="fix_method_name"></a><div id="fix_method_name-def"><a name="L125"></a><tt class="py-lineno"> 125</tt> <a class="py-toggle" href="#" id="fix_method_name-toggle" onclick="return toggle('fix_method_name');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#fix_method_name">fix_method_name</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="fix_method_name-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="fix_method_name-expanded"><a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"> <tt class="py-docstring">"""Fix method names to avoid reserved word conflicts.</tt> </tt>
+<a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"><tt class="py-docstring"> name: string, method name.</tt> </tt>
+<a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L131"></a><tt class="py-lineno"> 131</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"><tt class="py-docstring"> The name with a '_' prefixed if the name is a reserved word.</tt> </tt>
+<a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L134"></a><tt class="py-lineno"> 134</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">keyword</tt><tt class="py-op">.</tt><tt class="py-name">iskeyword</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt id="link-66" class="py-name"><a title="googleapiclient.discovery.RESERVED_WORDS" class="py-name" href="#" onclick="return doclink('link-66', 'RESERVED_WORDS', 'link-64');">RESERVED_WORDS</a></tt><tt class="py-op">:</tt> </tt>
+<a name="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">name</tt> <tt class="py-op">+</tt> <tt class="py-string">'_'</tt> </tt>
+<a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">name</tt> </tt>
+</div><a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"> </tt>
+<a name="key2param"></a><div id="key2param-def"><a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"> </tt>
+<a name="L140"></a><tt class="py-lineno"> 140</tt> <a class="py-toggle" href="#" id="key2param-toggle" onclick="return toggle('key2param');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#key2param">key2param</a><tt class="py-op">(</tt><tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="key2param-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="key2param-expanded"><a name="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"> <tt class="py-docstring">"""Converts key names into parameter names.</tt> </tt>
<a name="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"><tt class="py-docstring"> key: string, the method key name.</tt> </tt>
-<a name="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"><tt class="py-docstring"> A safe method name based on the key name.</tt> </tt>
-<a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L149"></a><tt class="py-lineno"> 149</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
-<a name="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"> <tt class="py-name">key</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">)</tt> </tt>
-<a name="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">key</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">isalpha</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'x'</tt><tt class="py-op">)</tt> </tt>
-<a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">c</tt> <tt class="py-keyword">in</tt> <tt class="py-name">key</tt><tt class="py-op">:</tt> </tt>
-<a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">c</tt><tt class="py-op">.</tt><tt class="py-name">isalnum</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L155"></a><tt class="py-lineno"> 155</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">c</tt><tt class="py-op">)</tt> </tt>
-<a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'_'</tt><tt class="py-op">)</tt> </tt>
-<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"> </tt>
-<a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"> </tt>
-<a name="build"></a><div id="build-def"><a name="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"> </tt>
-<a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"><tt class="py-decorator">@</tt><tt class="py-decorator">positional</tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
-<a name="L163"></a><tt class="py-lineno"> 163</tt> <a class="py-toggle" href="#" id="build-toggle" onclick="return toggle('build');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#build">build</a><tt class="py-op">(</tt><tt class="py-param">serviceName</tt><tt class="py-op">,</tt> </tt>
-<a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"> <tt class="py-param">version</tt><tt class="py-op">,</tt> </tt>
-<a name="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"> <tt class="py-param">http</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
-<a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"> <tt class="py-param">discoveryServiceUrl</tt><tt class="py-op">=</tt><tt id="link-61" class="py-name"><a title="googleapiclient.discovery.DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-61', 'DISCOVERY_URI', 'link-47');">DISCOVERY_URI</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"> <tt class="py-param">developerKey</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
-<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"> <tt class="py-param">model</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
-<a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"> <tt class="py-param">requestBuilder</tt><tt class="py-op">=</tt><tt id="link-62" class="py-name"><a title="googleapiclient.http.HttpRequest" class="py-name" href="#" onclick="return doclink('link-62', 'HttpRequest', 'link-25');">HttpRequest</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"> <tt class="py-param">credentials</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
-<a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"> <tt class="py-param">cache_discovery</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
-<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"> <tt class="py-param">cache</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="build-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="build-expanded"><a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"> <tt class="py-docstring">"""Construct a Resource for interacting with an API.</tt> </tt>
-<a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"><tt class="py-docstring"> Construct a Resource object for interacting with an API. The serviceName and</tt> </tt>
-<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"><tt class="py-docstring"> version are the names from the Discovery service.</tt> </tt>
-<a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L178"></a><tt class="py-lineno"> 178</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"><tt class="py-docstring"> serviceName: string, name of the service.</tt> </tt>
-<a name="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"><tt class="py-docstring"> version: string, the version of the service.</tt> </tt>
-<a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, An instance of httplib2.Http or something that acts</tt> </tt>
-<a name="L182"></a><tt class="py-lineno"> 182</tt> <tt class="py-line"><tt class="py-docstring"> like it that HTTP requests will be made through.</tt> </tt>
-<a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"><tt class="py-docstring"> discoveryServiceUrl: string, a URI Template that points to the location of</tt> </tt>
-<a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"><tt class="py-docstring"> the discovery service. It should have two parameters {api} and</tt> </tt>
-<a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"><tt class="py-docstring"> {apiVersion} that when filled in produce an absolute URI to the discovery</tt> </tt>
-<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"><tt class="py-docstring"> document for that service.</tt> </tt>
-<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"><tt class="py-docstring"> developerKey: string, key obtained from</tt> </tt>
-<a name="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"><tt class="py-docstring"> https://code.google.com/apis/console.</tt> </tt>
-<a name="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"><tt class="py-docstring"> model: googleapiclient.Model, converts to and from the wire format.</tt> </tt>
-<a name="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"><tt class="py-docstring"> requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP</tt> </tt>
-<a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"><tt class="py-docstring"> request.</tt> </tt>
-<a name="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"><tt class="py-docstring"> credentials: oauth2client.Credentials, credentials to be used for</tt> </tt>
-<a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"><tt class="py-docstring"> authentication.</tt> </tt>
-<a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"><tt class="py-docstring"> cache_discovery: Boolean, whether or not to cache the discovery doc.</tt> </tt>
-<a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"><tt class="py-docstring"> cache: googleapiclient.discovery_cache.base.CacheBase, an optional</tt> </tt>
-<a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"><tt class="py-docstring"> cache object for the discovery documents.</tt> </tt>
-<a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"><tt class="py-docstring"> A Resource object with methods for interacting with the service.</tt> </tt>
-<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
-<a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"> <tt class="py-string">'api'</tt><tt class="py-op">:</tt> <tt class="py-name">serviceName</tt><tt class="py-op">,</tt> </tt>
-<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"> <tt class="py-string">'apiVersion'</tt><tt class="py-op">:</tt> <tt class="py-name">version</tt> </tt>
-<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
-<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"> </tt>
-<a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-63" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-63', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> <tt id="link-64" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-64', 'http', 'link-21');">http</a></tt> <tt class="py-op">=</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Http</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"> </tt>
-<a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">discovery_url</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">discoveryServiceUrl</tt><tt class="py-op">,</tt> <tt id="link-65" class="py-name"><a title="googleapiclient.discovery.V2_DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-65', 'V2_DISCOVERY_URI', 'link-50');">V2_DISCOVERY_URI</a></tt><tt class="py-op">,</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"> <tt class="py-name">requested_url</tt> <tt class="py-op">=</tt> <tt class="py-name">uritemplate</tt><tt class="py-op">.</tt><tt class="py-name">expand</tt><tt class="py-op">(</tt><tt class="py-name">discovery_url</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
-<a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"> </tt>
-<a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
-<a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-66" class="py-name" targets="Function googleapiclient.discovery._retrieve_discovery_doc()=googleapiclient.discovery-module.html#_retrieve_discovery_doc"><a title="googleapiclient.discovery._retrieve_discovery_doc" class="py-name" href="#" onclick="return doclink('link-66', '_retrieve_discovery_doc', 'link-66');">_retrieve_discovery_doc</a></tt><tt class="py-op">(</tt><tt class="py-name">requested_url</tt><tt class="py-op">,</tt> <tt id="link-67" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-67', 'http', 'link-21');">http</a></tt><tt class="py-op">,</tt> <tt class="py-name">cache_discovery</tt><tt class="py-op">,</tt> </tt>
-<a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"> <tt id="link-68" class="py-name" targets="Variable googleapiclient.discovery_cache.appengine_memcache.cache=googleapiclient.discovery_cache.appengine_memcache-module.html#cache,Variable googleapiclient.discovery_cache.file_cache.cache=googleapiclient.discovery_cache.file_cache-module.html#cache"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
-googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-68', 'cache', 'link-68');">cache</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-69" class="py-name" targets="Function googleapiclient.discovery.build_from_document()=googleapiclient.discovery-module.html#build_from_document"><a title="googleapiclient.discovery.build_from_document" class="py-name" href="#" onclick="return doclink('link-69', 'build_from_document', 'link-69');">build_from_document</a></tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">,</tt> <tt id="link-70" class="py-name" targets="Module googleapiclient.discovery_cache.base=googleapiclient.discovery_cache.base-module.html"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-70', 'base', 'link-70');">base</a></tt><tt class="py-op">=</tt><tt class="py-name">discovery_url</tt><tt class="py-op">,</tt> <tt id="link-71" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-71', 'http', 'link-21');">http</a></tt><tt class="py-op">=</tt><tt id="link-72" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-72', 'http', 'link-21');">http</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"> <tt class="py-name">developerKey</tt><tt class="py-op">=</tt><tt class="py-name">developerKey</tt><tt class="py-op">,</tt> <tt id="link-73" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-73', 'model', 'link-33');">model</a></tt><tt class="py-op">=</tt><tt id="link-74" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-74', 'model', 'link-33');">model</a></tt><tt class="py-op">,</tt> <tt class="py-name">requestBuilder</tt><tt class="py-op">=</tt><tt class="py-name">requestBuilder</tt><tt class="py-op">,</tt> </tt>
-<a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"> <tt class="py-name">credentials</tt><tt class="py-op">=</tt><tt class="py-name">credentials</tt><tt class="py-op">)</tt> </tt>
-<a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-75" class="py-name"><a title="googleapiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-75', 'HttpError', 'link-4');">HttpError</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
-<a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-op">==</tt> <tt class="py-name">http_client</tt><tt class="py-op">.</tt><tt class="py-name">NOT_FOUND</tt><tt class="py-op">:</tt> </tt>
-<a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
-<a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">e</tt> </tt>
-<a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"> </tt>
-<a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-76" class="py-name"><a title="googleapiclient.errors.UnknownApiNameOrVersion" class="py-name" href="#" onclick="return doclink('link-76', 'UnknownApiNameOrVersion', 'link-16');">UnknownApiNameOrVersion</a></tt><tt class="py-op">(</tt> </tt>
-<a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"> <tt class="py-string">"name: %s version: %s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">serviceName</tt><tt class="py-op">,</tt> <tt class="py-name">version</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"> </tt>
-<a name="_retrieve_discovery_doc"></a><div id="_retrieve_discovery_doc-def"><a name="L227"></a><tt class="py-lineno"> 227</tt> <tt class="py-line"> </tt>
-<a name="L228"></a><tt class="py-lineno"> 228</tt> <a class="py-toggle" href="#" id="_retrieve_discovery_doc-toggle" onclick="return toggle('_retrieve_discovery_doc');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_retrieve_discovery_doc">_retrieve_discovery_doc</a><tt class="py-op">(</tt><tt class="py-param">url</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">,</tt> <tt class="py-param">cache_discovery</tt><tt class="py-op">,</tt> <tt class="py-param">cache</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="_retrieve_discovery_doc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_retrieve_discovery_doc-expanded"><a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"> <tt class="py-docstring">"""Retrieves the discovery_doc from cache or the internet.</tt> </tt>
-<a name="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"><tt class="py-docstring"> url: string, the URL of the discovery document.</tt> </tt>
-<a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, An instance of httplib2.Http or something that acts</tt> </tt>
-<a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"><tt class="py-docstring"> like it through which HTTP requests will be made.</tt> </tt>
-<a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"><tt class="py-docstring"> cache_discovery: Boolean, whether or not to cache the discovery doc.</tt> </tt>
-<a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"><tt class="py-docstring"> cache: googleapiclient.discovery_cache.base.Cache, an optional cache</tt> </tt>
-<a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"><tt class="py-docstring"> object for the discovery documents.</tt> </tt>
-<a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"><tt class="py-docstring"> A unicode string representation of the discovery document.</tt> </tt>
-<a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">cache_discovery</tt><tt class="py-op">:</tt> </tt>
-<a name="L243"></a><tt class="py-lineno"> 243</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-op">.</tt> <tt class="py-keyword">import</tt> <tt id="link-77" class="py-name" targets="Package googleapiclient.discovery_cache=googleapiclient.discovery_cache-module.html"><a title="googleapiclient.discovery_cache" class="py-name" href="#" onclick="return doclink('link-77', 'discovery_cache', 'link-77');">discovery_cache</a></tt> </tt>
-<a name="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-op">.</tt><tt id="link-78" class="py-name"><a title="googleapiclient.discovery_cache" class="py-name" href="#" onclick="return doclink('link-78', 'discovery_cache', 'link-77');">discovery_cache</a></tt> <tt class="py-keyword">import</tt> <tt id="link-79" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-79', 'base', 'link-70');">base</a></tt> </tt>
-<a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-80" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
-googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-80', 'cache', 'link-68');">cache</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"> <tt id="link-81" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
-googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-81', 'cache', 'link-68');">cache</a></tt> <tt class="py-op">=</tt> <tt id="link-82" class="py-name"><a title="googleapiclient.discovery_cache" class="py-name" href="#" onclick="return doclink('link-82', 'discovery_cache', 'link-77');">discovery_cache</a></tt><tt class="py-op">.</tt><tt id="link-83" class="py-name" targets="Function googleapiclient.discovery_cache.autodetect()=googleapiclient.discovery_cache-module.html#autodetect"><a title="googleapiclient.discovery_cache.autodetect" class="py-name" href="#" onclick="return doclink('link-83', 'autodetect', 'link-83');">autodetect</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-84" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
-googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-84', 'cache', 'link-68');">cache</a></tt><tt class="py-op">:</tt> </tt>
-<a name="L248"></a><tt class="py-lineno"> 248</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-85" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
-googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-85', 'cache', 'link-68');">cache</a></tt><tt class="py-op">.</tt><tt id="link-86" class="py-name" targets="Method googleapiclient.discovery_cache.appengine_memcache.Cache.get()=googleapiclient.discovery_cache.appengine_memcache.Cache-class.html#get,Method googleapiclient.discovery_cache.base.Cache.get()=googleapiclient.discovery_cache.base.Cache-class.html#get,Method googleapiclient.discovery_cache.file_cache.Cache.get()=googleapiclient.discovery_cache.file_cache.Cache-class.html#get,Method googleapiclient.schema.Schemas.get()=googleapiclient.schema.Schemas-class.html#get"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+<a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"><tt class="py-docstring"> For example, converting "max-results" -> "max_results"</tt> </tt>
+<a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"><tt class="py-docstring"> key: string, the method key name.</tt> </tt>
+<a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L149"></a><tt class="py-lineno"> 149</tt> <tt class="py-line"><tt class="py-docstring"> A safe method name based on the key name.</tt> </tt>
+<a name="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
+<a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"> <tt class="py-name">key</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">)</tt> </tt>
+<a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">key</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">isalpha</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'x'</tt><tt class="py-op">)</tt> </tt>
+<a name="L155"></a><tt class="py-lineno"> 155</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">c</tt> <tt class="py-keyword">in</tt> <tt class="py-name">key</tt><tt class="py-op">:</tt> </tt>
+<a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">c</tt><tt class="py-op">.</tt><tt class="py-name">isalnum</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">c</tt><tt class="py-op">)</tt> </tt>
+<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'_'</tt><tt class="py-op">)</tt> </tt>
+<a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"> </tt>
+<a name="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"> </tt>
+<a name="build"></a><div id="build-def"><a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"> </tt>
+<a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"><tt class="py-decorator">@</tt><tt class="py-decorator">positional</tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
+<a name="L165"></a><tt class="py-lineno"> 165</tt> <a class="py-toggle" href="#" id="build-toggle" onclick="return toggle('build');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#build">build</a><tt class="py-op">(</tt><tt class="py-param">serviceName</tt><tt class="py-op">,</tt> </tt>
+<a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"> <tt class="py-param">version</tt><tt class="py-op">,</tt> </tt>
+<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"> <tt class="py-param">http</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
+<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"> <tt class="py-param">discoveryServiceUrl</tt><tt class="py-op">=</tt><tt id="link-67" class="py-name"><a title="googleapiclient.discovery.DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-67', 'DISCOVERY_URI', 'link-53');">DISCOVERY_URI</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"> <tt class="py-param">developerKey</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
+<a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"> <tt class="py-param">model</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
+<a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"> <tt class="py-param">requestBuilder</tt><tt class="py-op">=</tt><tt id="link-68" class="py-name"><a title="googleapiclient.http.HttpRequest" class="py-name" href="#" onclick="return doclink('link-68', 'HttpRequest', 'link-31');">HttpRequest</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"> <tt class="py-param">credentials</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
+<a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"> <tt class="py-param">cache_discovery</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
+<a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"> <tt class="py-param">cache</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="build-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="build-expanded"><a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"> <tt class="py-docstring">"""Construct a Resource for interacting with an API.</tt> </tt>
+<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"><tt class="py-docstring"> Construct a Resource object for interacting with an API. The serviceName and</tt> </tt>
+<a name="L178"></a><tt class="py-lineno"> 178</tt> <tt class="py-line"><tt class="py-docstring"> version are the names from the Discovery service.</tt> </tt>
+<a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"><tt class="py-docstring"> serviceName: string, name of the service.</tt> </tt>
+<a name="L182"></a><tt class="py-lineno"> 182</tt> <tt class="py-line"><tt class="py-docstring"> version: string, the version of the service.</tt> </tt>
+<a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, An instance of httplib2.Http or something that acts</tt> </tt>
+<a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"><tt class="py-docstring"> like it that HTTP requests will be made through.</tt> </tt>
+<a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"><tt class="py-docstring"> discoveryServiceUrl: string, a URI Template that points to the location of</tt> </tt>
+<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"><tt class="py-docstring"> the discovery service. It should have two parameters {api} and</tt> </tt>
+<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"><tt class="py-docstring"> {apiVersion} that when filled in produce an absolute URI to the discovery</tt> </tt>
+<a name="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"><tt class="py-docstring"> document for that service.</tt> </tt>
+<a name="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"><tt class="py-docstring"> developerKey: string, key obtained from</tt> </tt>
+<a name="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"><tt class="py-docstring"> https://code.google.com/apis/console.</tt> </tt>
+<a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"><tt class="py-docstring"> model: googleapiclient.Model, converts to and from the wire format.</tt> </tt>
+<a name="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"><tt class="py-docstring"> requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP</tt> </tt>
+<a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"><tt class="py-docstring"> request.</tt> </tt>
+<a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"><tt class="py-docstring"> credentials: oauth2client.Credentials, credentials to be used for</tt> </tt>
+<a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"><tt class="py-docstring"> authentication.</tt> </tt>
+<a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"><tt class="py-docstring"> cache_discovery: Boolean, whether or not to cache the discovery doc.</tt> </tt>
+<a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"><tt class="py-docstring"> cache: googleapiclient.discovery_cache.base.CacheBase, an optional</tt> </tt>
+<a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"><tt class="py-docstring"> cache object for the discovery documents.</tt> </tt>
+<a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"><tt class="py-docstring"> A Resource object with methods for interacting with the service.</tt> </tt>
+<a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
+<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"> <tt class="py-string">'api'</tt><tt class="py-op">:</tt> <tt class="py-name">serviceName</tt><tt class="py-op">,</tt> </tt>
+<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"> <tt class="py-string">'apiVersion'</tt><tt class="py-op">:</tt> <tt class="py-name">version</tt> </tt>
+<a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
+<a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> </tt>
+<a name="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-69" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-69', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"> <tt id="link-70" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-70', 'http', 'link-21');">http</a></tt> <tt class="py-op">=</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Http</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"> </tt>
+<a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">discovery_url</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">discoveryServiceUrl</tt><tt class="py-op">,</tt> <tt id="link-71" class="py-name"><a title="googleapiclient.discovery.V2_DISCOVERY_URI" class="py-name" href="#" onclick="return doclink('link-71', 'V2_DISCOVERY_URI', 'link-56');">V2_DISCOVERY_URI</a></tt><tt class="py-op">,</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"> <tt class="py-name">requested_url</tt> <tt class="py-op">=</tt> <tt class="py-name">uritemplate</tt><tt class="py-op">.</tt><tt class="py-name">expand</tt><tt class="py-op">(</tt><tt class="py-name">discovery_url</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
+<a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"> </tt>
+<a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
+<a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-72" class="py-name" targets="Function googleapiclient.discovery._retrieve_discovery_doc()=googleapiclient.discovery-module.html#_retrieve_discovery_doc"><a title="googleapiclient.discovery._retrieve_discovery_doc" class="py-name" href="#" onclick="return doclink('link-72', '_retrieve_discovery_doc', 'link-72');">_retrieve_discovery_doc</a></tt><tt class="py-op">(</tt><tt class="py-name">requested_url</tt><tt class="py-op">,</tt> <tt id="link-73" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-73', 'http', 'link-21');">http</a></tt><tt class="py-op">,</tt> <tt class="py-name">cache_discovery</tt><tt class="py-op">,</tt> </tt>
+<a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"> <tt id="link-74" class="py-name" targets="Variable googleapiclient.discovery_cache.appengine_memcache.cache=googleapiclient.discovery_cache.appengine_memcache-module.html#cache,Variable googleapiclient.discovery_cache.file_cache.cache=googleapiclient.discovery_cache.file_cache-module.html#cache"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-74', 'cache', 'link-74');">cache</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-75" class="py-name" targets="Function googleapiclient.discovery.build_from_document()=googleapiclient.discovery-module.html#build_from_document"><a title="googleapiclient.discovery.build_from_document" class="py-name" href="#" onclick="return doclink('link-75', 'build_from_document', 'link-75');">build_from_document</a></tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">,</tt> <tt id="link-76" class="py-name" targets="Module googleapiclient.discovery_cache.base=googleapiclient.discovery_cache.base-module.html"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-76', 'base', 'link-76');">base</a></tt><tt class="py-op">=</tt><tt class="py-name">discovery_url</tt><tt class="py-op">,</tt> <tt id="link-77" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-77', 'http', 'link-21');">http</a></tt><tt class="py-op">=</tt><tt id="link-78" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-78', 'http', 'link-21');">http</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"> <tt class="py-name">developerKey</tt><tt class="py-op">=</tt><tt class="py-name">developerKey</tt><tt class="py-op">,</tt> <tt id="link-79" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-79', 'model', 'link-39');">model</a></tt><tt class="py-op">=</tt><tt id="link-80" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-80', 'model', 'link-39');">model</a></tt><tt class="py-op">,</tt> <tt class="py-name">requestBuilder</tt><tt class="py-op">=</tt><tt class="py-name">requestBuilder</tt><tt class="py-op">,</tt> </tt>
+<a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"> <tt class="py-name">credentials</tt><tt class="py-op">=</tt><tt class="py-name">credentials</tt><tt class="py-op">)</tt> </tt>
+<a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-81" class="py-name"><a title="googleapiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-81', 'HttpError', 'link-4');">HttpError</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
+<a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-op">==</tt> <tt class="py-name">http_client</tt><tt class="py-op">.</tt><tt class="py-name">NOT_FOUND</tt><tt class="py-op">:</tt> </tt>
+<a name="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
+<a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">e</tt> </tt>
+<a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"> </tt>
+<a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-82" class="py-name"><a title="googleapiclient.errors.UnknownApiNameOrVersion" class="py-name" href="#" onclick="return doclink('link-82', 'UnknownApiNameOrVersion', 'link-16');">UnknownApiNameOrVersion</a></tt><tt class="py-op">(</tt> </tt>
+<a name="L227"></a><tt class="py-lineno"> 227</tt> <tt class="py-line"> <tt class="py-string">"name: %s version: %s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">serviceName</tt><tt class="py-op">,</tt> <tt class="py-name">version</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L228"></a><tt class="py-lineno"> 228</tt> <tt class="py-line"> </tt>
+<a name="_retrieve_discovery_doc"></a><div id="_retrieve_discovery_doc-def"><a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"> </tt>
+<a name="L230"></a><tt class="py-lineno"> 230</tt> <a class="py-toggle" href="#" id="_retrieve_discovery_doc-toggle" onclick="return toggle('_retrieve_discovery_doc');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_retrieve_discovery_doc">_retrieve_discovery_doc</a><tt class="py-op">(</tt><tt class="py-param">url</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">,</tt> <tt class="py-param">cache_discovery</tt><tt class="py-op">,</tt> <tt class="py-param">cache</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="_retrieve_discovery_doc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_retrieve_discovery_doc-expanded"><a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"> <tt class="py-docstring">"""Retrieves the discovery_doc from cache or the internet.</tt> </tt>
+<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"><tt class="py-docstring"> url: string, the URL of the discovery document.</tt> </tt>
+<a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, An instance of httplib2.Http or something that acts</tt> </tt>
+<a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"><tt class="py-docstring"> like it through which HTTP requests will be made.</tt> </tt>
+<a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"><tt class="py-docstring"> cache_discovery: Boolean, whether or not to cache the discovery doc.</tt> </tt>
+<a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"><tt class="py-docstring"> cache: googleapiclient.discovery_cache.base.Cache, an optional cache</tt> </tt>
+<a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"><tt class="py-docstring"> object for the discovery documents.</tt> </tt>
+<a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"><tt class="py-docstring"> A unicode string representation of the discovery document.</tt> </tt>
+<a name="L243"></a><tt class="py-lineno"> 243</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">cache_discovery</tt><tt class="py-op">:</tt> </tt>
+<a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-op">.</tt> <tt class="py-keyword">import</tt> <tt id="link-83" class="py-name" targets="Package googleapiclient.discovery_cache=googleapiclient.discovery_cache-module.html"><a title="googleapiclient.discovery_cache" class="py-name" href="#" onclick="return doclink('link-83', 'discovery_cache', 'link-83');">discovery_cache</a></tt> </tt>
+<a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-op">.</tt><tt id="link-84" class="py-name"><a title="googleapiclient.discovery_cache" class="py-name" href="#" onclick="return doclink('link-84', 'discovery_cache', 'link-83');">discovery_cache</a></tt> <tt class="py-keyword">import</tt> <tt id="link-85" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-85', 'base', 'link-76');">base</a></tt> </tt>
+<a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-86" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-86', 'cache', 'link-74');">cache</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L248"></a><tt class="py-lineno"> 248</tt> <tt class="py-line"> <tt id="link-87" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-87', 'cache', 'link-74');">cache</a></tt> <tt class="py-op">=</tt> <tt id="link-88" class="py-name"><a title="googleapiclient.discovery_cache" class="py-name" href="#" onclick="return doclink('link-88', 'discovery_cache', 'link-83');">discovery_cache</a></tt><tt class="py-op">.</tt><tt id="link-89" class="py-name" targets="Function googleapiclient.discovery_cache.autodetect()=googleapiclient.discovery_cache-module.html#autodetect"><a title="googleapiclient.discovery_cache.autodetect" class="py-name" href="#" onclick="return doclink('link-89', 'autodetect', 'link-89');">autodetect</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-90" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-90', 'cache', 'link-74');">cache</a></tt><tt class="py-op">:</tt> </tt>
+<a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-91" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-91', 'cache', 'link-74');">cache</a></tt><tt class="py-op">.</tt><tt id="link-92" class="py-name" targets="Method googleapiclient.discovery_cache.appengine_memcache.Cache.get()=googleapiclient.discovery_cache.appengine_memcache.Cache-class.html#get,Method googleapiclient.discovery_cache.base.Cache.get()=googleapiclient.discovery_cache.base.Cache-class.html#get,Method googleapiclient.discovery_cache.file_cache.Cache.get()=googleapiclient.discovery_cache.file_cache.Cache-class.html#get,Method googleapiclient.schema.Schemas.get()=googleapiclient.schema.Schemas-class.html#get"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-86', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
-<a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">content</tt><tt class="py-op">:</tt> </tt>
-<a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">content</tt> </tt>
-<a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"> </tt>
-<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"> <tt class="py-name">actual_url</tt> <tt class="py-op">=</tt> <tt class="py-name">url</tt> </tt>
-<a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"> <tt class="py-comment"># REMOTE_ADDR is defined by the CGI spec [RFC3875] as the environment</tt> </tt>
-<a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"> <tt class="py-comment"># variable that contains the network address of the client sending the</tt> </tt>
-<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"> <tt class="py-comment"># request. If it exists then add that to the request for the discovery</tt> </tt>
-<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"> <tt class="py-comment"># document to avoid exceeding the quota on discovery requests.</tt> </tt>
-<a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'REMOTE_ADDR'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">environ</tt><tt class="py-op">:</tt> </tt>
-<a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"> <tt class="py-name">actual_url</tt> <tt class="py-op">=</tt> <tt class="py-name">_add_query_parameter</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-string">'userIp'</tt><tt class="py-op">,</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">environ</tt><tt class="py-op">[</tt><tt class="py-string">'REMOTE_ADDR'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="L259"></a><tt class="py-lineno"> 259</tt> <tt class="py-line"> <tt id="link-87" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-87', 'logger', 'link-44');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'URL being requested: GET %s'</tt><tt class="py-op">,</tt> <tt class="py-name">actual_url</tt><tt class="py-op">)</tt> </tt>
-<a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"> </tt>
-<a name="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-88" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-88', 'http', 'link-21');">http</a></tt><tt class="py-op">.</tt><tt id="link-89" class="py-name" targets="Method googleapiclient.http.HttpMock.request()=googleapiclient.http.HttpMock-class.html#request,Method googleapiclient.http.HttpMockSequence.request()=googleapiclient.http.HttpMockSequence-class.html#request,Method googleapiclient.model.BaseModel.request()=googleapiclient.model.BaseModel-class.html#request,Method googleapiclient.model.Model.request()=googleapiclient.model.Model-class.html#request"><a title="googleapiclient.http.HttpMock.request
-googleapiclient.http.HttpMockSequence.request
-googleapiclient.model.BaseModel.request
-googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-89', 'request', 'link-89');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">actual_url</tt><tt class="py-op">)</tt> </tt>
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-92', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
+<a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">content</tt><tt class="py-op">:</tt> </tt>
+<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">content</tt> </tt>
+<a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"> </tt>
+<a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"> <tt class="py-name">actual_url</tt> <tt class="py-op">=</tt> <tt class="py-name">url</tt> </tt>
+<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"> <tt class="py-comment"># REMOTE_ADDR is defined by the CGI spec [RFC3875] as the environment</tt> </tt>
+<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"> <tt class="py-comment"># variable that contains the network address of the client sending the</tt> </tt>
+<a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"> <tt class="py-comment"># request. If it exists then add that to the request for the discovery</tt> </tt>
+<a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"> <tt class="py-comment"># document to avoid exceeding the quota on discovery requests.</tt> </tt>
+<a name="L259"></a><tt class="py-lineno"> 259</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'REMOTE_ADDR'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">environ</tt><tt class="py-op">:</tt> </tt>
+<a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"> <tt class="py-name">actual_url</tt> <tt class="py-op">=</tt> <tt class="py-name">_add_query_parameter</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-string">'userIp'</tt><tt class="py-op">,</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">environ</tt><tt class="py-op">[</tt><tt class="py-string">'REMOTE_ADDR'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"> <tt id="link-93" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-93', 'logger', 'link-50');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'URL being requested: GET %s'</tt><tt class="py-op">,</tt> <tt class="py-name">actual_url</tt><tt class="py-op">)</tt> </tt>
<a name="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"> </tt>
-<a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-op">>=</tt> <tt class="py-number">400</tt><tt class="py-op">:</tt> </tt>
-<a name="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-90" class="py-name"><a title="googleapiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-90', 'HttpError', 'link-4');">HttpError</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">uri</tt><tt class="py-op">=</tt><tt class="py-name">actual_url</tt><tt class="py-op">)</tt> </tt>
-<a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"> </tt>
-<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
-<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">content</tt><tt class="py-op">.</tt><tt class="py-name">decode</tt><tt class="py-op">(</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt> </tt>
-<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
-<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
-<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"> </tt>
-<a name="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
-<a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"> <tt class="py-name">service</tt> <tt class="py-op">=</tt> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">loads</tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
-<a name="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt> <tt class="py-keyword">as</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
-<a name="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"> <tt id="link-91" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-91', 'logger', 'link-44');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">(</tt><tt class="py-string">'Failed to parse as JSON: '</tt> <tt class="py-op">+</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
-<a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-92" class="py-name"><a title="googleapiclient.errors.InvalidJsonError" class="py-name" href="#" onclick="return doclink('link-92', 'InvalidJsonError', 'link-7');">InvalidJsonError</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">cache_discovery</tt> <tt class="py-keyword">and</tt> <tt id="link-93" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
-googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-93', 'cache', 'link-68');">cache</a></tt><tt class="py-op">:</tt> </tt>
-<a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"> <tt id="link-94" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
-googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-94', 'cache', 'link-68');">cache</a></tt><tt class="py-op">.</tt><tt id="link-95" class="py-name" targets="Method googleapiclient.discovery_cache.appengine_memcache.Cache.set()=googleapiclient.discovery_cache.appengine_memcache.Cache-class.html#set,Method googleapiclient.discovery_cache.base.Cache.set()=googleapiclient.discovery_cache.base.Cache-class.html#set,Method googleapiclient.discovery_cache.file_cache.Cache.set()=googleapiclient.discovery_cache.file_cache.Cache-class.html#set"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.set
+<a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-94" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-94', 'http', 'link-21');">http</a></tt><tt class="py-op">.</tt><tt id="link-95" class="py-name" targets="Method googleapiclient.http.HttpMock.request()=googleapiclient.http.HttpMock-class.html#request,Method googleapiclient.http.HttpMockSequence.request()=googleapiclient.http.HttpMockSequence-class.html#request,Method googleapiclient.model.BaseModel.request()=googleapiclient.model.BaseModel-class.html#request,Method googleapiclient.model.Model.request()=googleapiclient.model.Model-class.html#request"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.http.HttpMockSequence.request
+googleapiclient.model.BaseModel.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-95', 'request', 'link-95');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">actual_url</tt><tt class="py-op">)</tt> </tt>
+<a name="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"> </tt>
+<a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-op">>=</tt> <tt class="py-number">400</tt><tt class="py-op">:</tt> </tt>
+<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-96" class="py-name"><a title="googleapiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-96', 'HttpError', 'link-4');">HttpError</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">uri</tt><tt class="py-op">=</tt><tt class="py-name">actual_url</tt><tt class="py-op">)</tt> </tt>
+<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"> </tt>
+<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
+<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">content</tt><tt class="py-op">.</tt><tt class="py-name">decode</tt><tt class="py-op">(</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt> </tt>
+<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
+<a name="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
+<a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"> </tt>
+<a name="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
+<a name="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"> <tt class="py-name">service</tt> <tt class="py-op">=</tt> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">loads</tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
+<a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt> <tt class="py-keyword">as</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
+<a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"> <tt id="link-97" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-97', 'logger', 'link-50');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">(</tt><tt class="py-string">'Failed to parse as JSON: '</tt> <tt class="py-op">+</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
+<a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-98" class="py-name"><a title="googleapiclient.errors.InvalidJsonError" class="py-name" href="#" onclick="return doclink('link-98', 'InvalidJsonError', 'link-7');">InvalidJsonError</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">cache_discovery</tt> <tt class="py-keyword">and</tt> <tt id="link-99" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-99', 'cache', 'link-74');">cache</a></tt><tt class="py-op">:</tt> </tt>
+<a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"> <tt id="link-100" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-100', 'cache', 'link-74');">cache</a></tt><tt class="py-op">.</tt><tt id="link-101" class="py-name" targets="Method googleapiclient.discovery_cache.appengine_memcache.Cache.set()=googleapiclient.discovery_cache.appengine_memcache.Cache-class.html#set,Method googleapiclient.discovery_cache.base.Cache.set()=googleapiclient.discovery_cache.base.Cache-class.html#set,Method googleapiclient.discovery_cache.file_cache.Cache.set()=googleapiclient.discovery_cache.file_cache.Cache-class.html#set"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.set
googleapiclient.discovery_cache.base.Cache.set
-googleapiclient.discovery_cache.file_cache.Cache.set" class="py-name" href="#" onclick="return doclink('link-95', 'set', 'link-95');">set</a></tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
-<a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">content</tt> </tt>
-</div><a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"> </tt>
-<a name="build_from_document"></a><div id="build_from_document-def"><a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"> </tt>
-<a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"><tt class="py-decorator">@</tt><tt class="py-decorator">positional</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
-<a name="L282"></a><tt class="py-lineno"> 282</tt> <a class="py-toggle" href="#" id="build_from_document-toggle" onclick="return toggle('build_from_document');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#build_from_document">build_from_document</a><tt class="py-op">(</tt> </tt>
-<a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"> <tt class="py-param">service</tt><tt class="py-op">,</tt> </tt>
-<a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"> <tt class="py-param">base</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
-<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"> <tt class="py-param">future</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
-<a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"> <tt class="py-param">http</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
-<a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"> <tt class="py-param">developerKey</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
-<a name="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"> <tt class="py-param">model</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
-<a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"> <tt class="py-param">requestBuilder</tt><tt class="py-op">=</tt><tt id="link-96" class="py-name"><a title="googleapiclient.http.HttpRequest" class="py-name" href="#" onclick="return doclink('link-96', 'HttpRequest', 'link-25');">HttpRequest</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"> <tt class="py-param">credentials</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="build_from_document-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="build_from_document-expanded"><a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a Resource for interacting with an API.</tt> </tt>
-<a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"><tt class="py-docstring"> Same as `build()`, but constructs the Resource object from a discovery</tt> </tt>
-<a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"><tt class="py-docstring"> document that is it given, as opposed to retrieving one over HTTP.</tt> </tt>
-<a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"><tt class="py-docstring"> service: string or object, the JSON discovery document describing the API.</tt> </tt>
-<a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"><tt class="py-docstring"> The value passed in may either be the JSON string or the deserialized</tt> </tt>
-<a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"><tt class="py-docstring"> JSON.</tt> </tt>
-<a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"><tt class="py-docstring"> base: string, base URI for all HTTP requests, usually the discovery URI.</tt> </tt>
-<a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"><tt class="py-docstring"> This parameter is no longer used as rootUrl and servicePath are included</tt> </tt>
-<a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"><tt class="py-docstring"> within the discovery document. (deprecated)</tt> </tt>
-<a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"><tt class="py-docstring"> future: string, discovery document with future capabilities (deprecated).</tt> </tt>
-<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, An instance of httplib2.Http or something that acts</tt> </tt>
-<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"><tt class="py-docstring"> like it that HTTP requests will be made through.</tt> </tt>
-<a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"><tt class="py-docstring"> developerKey: string, Key for controlling API usage, generated</tt> </tt>
-<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"><tt class="py-docstring"> from the API Console.</tt> </tt>
-<a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"><tt class="py-docstring"> model: Model class instance that serializes and de-serializes requests and</tt> </tt>
-<a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"><tt class="py-docstring"> responses.</tt> </tt>
-<a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"><tt class="py-docstring"> requestBuilder: Takes an http request and packages it up to be executed.</tt> </tt>
-<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"><tt class="py-docstring"> credentials: object, credentials to be used for authentication.</tt> </tt>
-<a name="L312"></a><tt class="py-lineno"> 312</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"><tt class="py-docstring"> A Resource object with methods for interacting with the service.</tt> </tt>
-<a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L316"></a><tt class="py-lineno"> 316</tt> <tt class="py-line"> </tt>
-<a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-97" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-97', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"> <tt id="link-98" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-98', 'http', 'link-21');">http</a></tt> <tt class="py-op">=</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Http</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L319"></a><tt class="py-lineno"> 319</tt> <tt class="py-line"> </tt>
-<a name="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"> <tt class="py-comment"># future is no longer used.</tt> </tt>
-<a name="L321"></a><tt class="py-lineno"> 321</tt> <tt class="py-line"> <tt class="py-name">future</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
-<a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"> </tt>
-<a name="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">service</tt><tt class="py-op">,</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">string_types</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"> <tt class="py-name">service</tt> <tt class="py-op">=</tt> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">loads</tt><tt class="py-op">(</tt><tt class="py-name">service</tt><tt class="py-op">)</tt> </tt>
-<a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"> </tt>
-<a name="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'rootUrl'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">service</tt> <tt class="py-keyword">and</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-99" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-99', 'http', 'link-21');">http</a></tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt id="link-100" class="py-name" targets="Class googleapiclient.http.HttpMock=googleapiclient.http.HttpMock-class.html"><a title="googleapiclient.http.HttpMock" class="py-name" href="#" onclick="return doclink('link-100', 'HttpMock', 'link-100');">HttpMock</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"> <tt id="link-101" class="py-name" targets="Class googleapiclient.http.HttpMockSequence=googleapiclient.http.HttpMockSequence-class.html"><a title="googleapiclient.http.HttpMockSequence" class="py-name" href="#" onclick="return doclink('link-101', 'HttpMockSequence', 'link-101');">HttpMockSequence</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"> <tt id="link-102" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-102', 'logger', 'link-44');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">(</tt><tt class="py-string">"You are using HttpMock or HttpMockSequence without"</tt> <tt class="py-op">+</tt> </tt>
-<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"> <tt class="py-string">"having the service discovery doc in cache. Try calling "</tt> <tt class="py-op">+</tt> </tt>
-<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"> <tt class="py-string">"build() without mocking once first to populate the "</tt> <tt class="py-op">+</tt> </tt>
-<a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> <tt class="py-string">"cache."</tt><tt class="py-op">)</tt> </tt>
-<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-103" class="py-name"><a title="googleapiclient.errors.InvalidJsonError" class="py-name" href="#" onclick="return doclink('link-103', 'InvalidJsonError', 'link-7');">InvalidJsonError</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"> </tt>
-<a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"> <tt id="link-104" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-104', 'base', 'link-70');">base</a></tt> <tt class="py-op">=</tt> <tt class="py-name">urljoin</tt><tt class="py-op">(</tt><tt class="py-name">service</tt><tt class="py-op">[</tt><tt class="py-string">'rootUrl'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">service</tt><tt class="py-op">[</tt><tt class="py-string">'servicePath'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"> <tt id="link-105" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-105', 'schema', 'link-42');">schema</a></tt> <tt class="py-op">=</tt> <tt id="link-106" class="py-name"><a title="googleapiclient.schema.Schemas" class="py-name" href="#" onclick="return doclink('link-106', 'Schemas', 'link-43');">Schemas</a></tt><tt class="py-op">(</tt><tt class="py-name">service</tt><tt class="py-op">)</tt> </tt>
-<a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"> </tt>
-<a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">credentials</tt><tt class="py-op">:</tt> </tt>
-<a name="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"> <tt class="py-comment"># If credentials were passed in, we could have two cases:</tt> </tt>
-<a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"> <tt class="py-comment"># 1. the scopes were specified, in which case the given credentials</tt> </tt>
-<a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"> <tt class="py-comment"># are used for authorizing the http;</tt> </tt>
-<a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"> <tt class="py-comment"># 2. the scopes were not provided (meaning the Application Default</tt> </tt>
-<a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> <tt class="py-comment"># Credentials are to be used). In this case, the Application Default</tt> </tt>
-<a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"> <tt class="py-comment"># Credentials are built and used instead of the original credentials.</tt> </tt>
-<a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"> <tt class="py-comment"># If there are no scopes found (meaning the given service requires no</tt> </tt>
-<a name="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"> <tt class="py-comment"># authentication), there is no authorization of the http.</tt> </tt>
-<a name="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">credentials</tt><tt class="py-op">,</tt> <tt class="py-name">GoogleCredentials</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
-<a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">create_scoped_required</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"> <tt class="py-name">scopes</tt> <tt class="py-op">=</tt> <tt class="py-name">service</tt><tt class="py-op">.</tt><tt id="link-107" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.discovery_cache.file_cache.Cache.set" class="py-name" href="#" onclick="return doclink('link-101', 'set', 'link-101');">set</a></tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
+<a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">content</tt> </tt>
+</div><a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"> </tt>
+<a name="build_from_document"></a><div id="build_from_document-def"><a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"> </tt>
+<a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"><tt class="py-decorator">@</tt><tt class="py-decorator">positional</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
+<a name="L284"></a><tt class="py-lineno"> 284</tt> <a class="py-toggle" href="#" id="build_from_document-toggle" onclick="return toggle('build_from_document');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#build_from_document">build_from_document</a><tt class="py-op">(</tt> </tt>
+<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"> <tt class="py-param">service</tt><tt class="py-op">,</tt> </tt>
+<a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"> <tt class="py-param">base</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
+<a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"> <tt class="py-param">future</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
+<a name="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"> <tt class="py-param">http</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
+<a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"> <tt class="py-param">developerKey</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
+<a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"> <tt class="py-param">model</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
+<a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"> <tt class="py-param">requestBuilder</tt><tt class="py-op">=</tt><tt id="link-102" class="py-name"><a title="googleapiclient.http.HttpRequest" class="py-name" href="#" onclick="return doclink('link-102', 'HttpRequest', 'link-31');">HttpRequest</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"> <tt class="py-param">credentials</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="build_from_document-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="build_from_document-expanded"><a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a Resource for interacting with an API.</tt> </tt>
+<a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"><tt class="py-docstring"> Same as `build()`, but constructs the Resource object from a discovery</tt> </tt>
+<a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"><tt class="py-docstring"> document that is it given, as opposed to retrieving one over HTTP.</tt> </tt>
+<a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"><tt class="py-docstring"> service: string or object, the JSON discovery document describing the API.</tt> </tt>
+<a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"><tt class="py-docstring"> The value passed in may either be the JSON string or the deserialized</tt> </tt>
+<a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"><tt class="py-docstring"> JSON.</tt> </tt>
+<a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"><tt class="py-docstring"> base: string, base URI for all HTTP requests, usually the discovery URI.</tt> </tt>
+<a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"><tt class="py-docstring"> This parameter is no longer used as rootUrl and servicePath are included</tt> </tt>
+<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"><tt class="py-docstring"> within the discovery document. (deprecated)</tt> </tt>
+<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"><tt class="py-docstring"> future: string, discovery document with future capabilities (deprecated).</tt> </tt>
+<a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, An instance of httplib2.Http or something that acts</tt> </tt>
+<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"><tt class="py-docstring"> like it that HTTP requests will be made through.</tt> </tt>
+<a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"><tt class="py-docstring"> developerKey: string, Key for controlling API usage, generated</tt> </tt>
+<a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"><tt class="py-docstring"> from the API Console.</tt> </tt>
+<a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"><tt class="py-docstring"> model: Model class instance that serializes and de-serializes requests and</tt> </tt>
+<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"><tt class="py-docstring"> responses.</tt> </tt>
+<a name="L312"></a><tt class="py-lineno"> 312</tt> <tt class="py-line"><tt class="py-docstring"> requestBuilder: Takes an http request and packages it up to be executed.</tt> </tt>
+<a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"><tt class="py-docstring"> credentials: object, credentials to be used for authentication.</tt> </tt>
+<a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L316"></a><tt class="py-lineno"> 316</tt> <tt class="py-line"><tt class="py-docstring"> A Resource object with methods for interacting with the service.</tt> </tt>
+<a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"> </tt>
+<a name="L319"></a><tt class="py-lineno"> 319</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-103" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-103', 'http', 'link-21');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"> <tt id="link-104" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-104', 'http', 'link-21');">http</a></tt> <tt class="py-op">=</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Http</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L321"></a><tt class="py-lineno"> 321</tt> <tt class="py-line"> </tt>
+<a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"> <tt class="py-comment"># future is no longer used.</tt> </tt>
+<a name="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"> <tt class="py-name">future</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
+<a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"> </tt>
+<a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">service</tt><tt class="py-op">,</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">string_types</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"> <tt class="py-name">service</tt> <tt class="py-op">=</tt> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">loads</tt><tt class="py-op">(</tt><tt class="py-name">service</tt><tt class="py-op">)</tt> </tt>
+<a name="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"> </tt>
+<a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'rootUrl'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">service</tt> <tt class="py-keyword">and</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-105" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-105', 'http', 'link-21');">http</a></tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt id="link-106" class="py-name"><a title="googleapiclient.http.HttpMock" class="py-name" href="#" onclick="return doclink('link-106', 'HttpMock', 'link-25');">HttpMock</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"> <tt id="link-107" class="py-name"><a title="googleapiclient.http.HttpMockSequence" class="py-name" href="#" onclick="return doclink('link-107', 'HttpMockSequence', 'link-28');">HttpMockSequence</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"> <tt id="link-108" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-108', 'logger', 'link-50');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">(</tt><tt class="py-string">"You are using HttpMock or HttpMockSequence without"</tt> <tt class="py-op">+</tt> </tt>
+<a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> <tt class="py-string">"having the service discovery doc in cache. Try calling "</tt> <tt class="py-op">+</tt> </tt>
+<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"> <tt class="py-string">"build() without mocking once first to populate the "</tt> <tt class="py-op">+</tt> </tt>
+<a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"> <tt class="py-string">"cache."</tt><tt class="py-op">)</tt> </tt>
+<a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-109" class="py-name"><a title="googleapiclient.errors.InvalidJsonError" class="py-name" href="#" onclick="return doclink('link-109', 'InvalidJsonError', 'link-7');">InvalidJsonError</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"> </tt>
+<a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"> <tt id="link-110" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-110', 'base', 'link-76');">base</a></tt> <tt class="py-op">=</tt> <tt class="py-name">urljoin</tt><tt class="py-op">(</tt><tt class="py-name">service</tt><tt class="py-op">[</tt><tt class="py-string">'rootUrl'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">service</tt><tt class="py-op">[</tt><tt class="py-string">'servicePath'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"> <tt id="link-111" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-111', 'schema', 'link-48');">schema</a></tt> <tt class="py-op">=</tt> <tt id="link-112" class="py-name"><a title="googleapiclient.schema.Schemas" class="py-name" href="#" onclick="return doclink('link-112', 'Schemas', 'link-49');">Schemas</a></tt><tt class="py-op">(</tt><tt class="py-name">service</tt><tt class="py-op">)</tt> </tt>
+<a name="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"> </tt>
+<a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">credentials</tt><tt class="py-op">:</tt> </tt>
+<a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"> <tt class="py-comment"># If credentials were passed in, we could have two cases:</tt> </tt>
+<a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"> <tt class="py-comment"># 1. the scopes were specified, in which case the given credentials</tt> </tt>
+<a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> <tt class="py-comment"># are used for authorizing the http;</tt> </tt>
+<a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"> <tt class="py-comment"># 2. the scopes were not provided (meaning the Application Default</tt> </tt>
+<a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"> <tt class="py-comment"># Credentials are to be used). In this case, the Application Default</tt> </tt>
+<a name="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"> <tt class="py-comment"># Credentials are built and used instead of the original credentials.</tt> </tt>
+<a name="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"> <tt class="py-comment"># If there are no scopes found (meaning the given service requires no</tt> </tt>
+<a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"> <tt class="py-comment"># authentication), there is no authorization of the http.</tt> </tt>
+<a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">credentials</tt><tt class="py-op">,</tt> <tt class="py-name">GoogleCredentials</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
+<a name="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">create_scoped_required</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"> <tt class="py-name">scopes</tt> <tt class="py-op">=</tt> <tt class="py-name">service</tt><tt class="py-op">.</tt><tt id="link-113" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-107', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'auth'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-108" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-113', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'auth'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-114" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-108', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'oauth2'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-109" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-114', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'oauth2'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-115" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-109', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'scopes'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
-<a name="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">scopes</tt><tt class="py-op">:</tt> </tt>
-<a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"> <tt class="py-name">credentials</tt> <tt class="py-op">=</tt> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">create_scoped</tt><tt class="py-op">(</tt><tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">scopes</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"> <tt class="py-comment"># No need to authorize the http object</tt> </tt>
-<a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"> <tt class="py-comment"># if the service does not require authentication.</tt> </tt>
-<a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"> <tt class="py-name">credentials</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
-<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"> </tt>
-<a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">credentials</tt><tt class="py-op">:</tt> </tt>
-<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"> <tt id="link-110" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-110', 'http', 'link-21');">http</a></tt> <tt class="py-op">=</tt> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">authorize</tt><tt class="py-op">(</tt><tt id="link-111" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-111', 'http', 'link-21');">http</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"> </tt>
-<a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-112" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-112', 'model', 'link-33');">model</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"> <tt class="py-name">features</tt> <tt class="py-op">=</tt> <tt class="py-name">service</tt><tt class="py-op">.</tt><tt id="link-113" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-115', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'scopes'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
+<a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">scopes</tt><tt class="py-op">:</tt> </tt>
+<a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"> <tt class="py-name">credentials</tt> <tt class="py-op">=</tt> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">create_scoped</tt><tt class="py-op">(</tt><tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">scopes</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"> <tt class="py-comment"># No need to authorize the http object</tt> </tt>
+<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"> <tt class="py-comment"># if the service does not require authentication.</tt> </tt>
+<a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"> <tt class="py-name">credentials</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
+<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"> </tt>
+<a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">credentials</tt><tt class="py-op">:</tt> </tt>
+<a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"> <tt id="link-116" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-116', 'http', 'link-21');">http</a></tt> <tt class="py-op">=</tt> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">authorize</tt><tt class="py-op">(</tt><tt id="link-117" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-117', 'http', 'link-21');">http</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"> </tt>
+<a name="L361"></a><tt class="py-lineno"> 361</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-118" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-118', 'model', 'link-39');">model</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"> <tt class="py-name">features</tt> <tt class="py-op">=</tt> <tt class="py-name">service</tt><tt class="py-op">.</tt><tt id="link-119" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-113', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'features'</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="L361"></a><tt class="py-lineno"> 361</tt> <tt class="py-line"> <tt id="link-114" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-114', 'model', 'link-33');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-115" class="py-name"><a title="googleapiclient.model.JsonModel" class="py-name" href="#" onclick="return doclink('link-115', 'JsonModel', 'link-34');">JsonModel</a></tt><tt class="py-op">(</tt><tt class="py-string">'dataWrapper'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">features</tt><tt class="py-op">)</tt> </tt>
-<a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-116" class="py-name" targets="Class googleapiclient.discovery.Resource=googleapiclient.discovery.Resource-class.html"><a title="googleapiclient.discovery.Resource" class="py-name" href="#" onclick="return doclink('link-116', 'Resource', 'link-116');">Resource</a></tt><tt class="py-op">(</tt><tt id="link-117" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-117', 'http', 'link-21');">http</a></tt><tt class="py-op">=</tt><tt id="link-118" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-118', 'http', 'link-21');">http</a></tt><tt class="py-op">,</tt> <tt class="py-name">baseUrl</tt><tt class="py-op">=</tt><tt id="link-119" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-119', 'base', 'link-70');">base</a></tt><tt class="py-op">,</tt> <tt id="link-120" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-120', 'model', 'link-33');">model</a></tt><tt class="py-op">=</tt><tt id="link-121" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-121', 'model', 'link-33');">model</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"> <tt class="py-name">developerKey</tt><tt class="py-op">=</tt><tt class="py-name">developerKey</tt><tt class="py-op">,</tt> <tt class="py-name">requestBuilder</tt><tt class="py-op">=</tt><tt class="py-name">requestBuilder</tt><tt class="py-op">,</tt> </tt>
-<a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> <tt class="py-name">resourceDesc</tt><tt class="py-op">=</tt><tt class="py-name">service</tt><tt class="py-op">,</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">=</tt><tt class="py-name">service</tt><tt class="py-op">,</tt> <tt id="link-122" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-122', 'schema', 'link-42');">schema</a></tt><tt class="py-op">=</tt><tt id="link-123" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-123', 'schema', 'link-42');">schema</a></tt><tt class="py-op">)</tt> </tt>
-</div><a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"> </tt>
-<a name="_cast"></a><div id="_cast-def"><a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"> </tt>
-<a name="L367"></a><tt class="py-lineno"> 367</tt> <a class="py-toggle" href="#" id="_cast-toggle" onclick="return toggle('_cast');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_cast">_cast</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">,</tt> <tt class="py-param">schema_type</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="_cast-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_cast-expanded"><a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert value to a string based on JSON Schema type.</tt> </tt>
-<a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"><tt class="py-docstring"> See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on</tt> </tt>
-<a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"><tt class="py-docstring"> JSON Schema.</tt> </tt>
-<a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"><tt class="py-docstring"> value: any, the value to convert</tt> </tt>
-<a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"><tt class="py-docstring"> schema_type: string, the type that value should be interpreted as</tt> </tt>
-<a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"><tt class="py-docstring"> A string representation of 'value' based on the schema_type.</tt> </tt>
-<a name="L379"></a><tt class="py-lineno"> 379</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">schema_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'string'</tt><tt class="py-op">:</tt> </tt>
-<a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-string">''</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-string">u''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">value</tt> </tt>
-<a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
-<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">schema_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'integer'</tt><tt class="py-op">:</tt> </tt>
-<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">schema_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'number'</tt><tt class="py-op">:</tt> </tt>
-<a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L389"></a><tt class="py-lineno"> 389</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">schema_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'boolean'</tt><tt class="py-op">:</tt> </tt>
-<a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">bool</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-string">''</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-string">u''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">value</tt> </tt>
-<a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"> </tt>
-<a name="_media_size_to_long"></a><div id="_media_size_to_long-def"><a name="L397"></a><tt class="py-lineno"> 397</tt> <tt class="py-line"> </tt>
-<a name="L398"></a><tt class="py-lineno"> 398</tt> <a class="py-toggle" href="#" id="_media_size_to_long-toggle" onclick="return toggle('_media_size_to_long');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_media_size_to_long">_media_size_to_long</a><tt class="py-op">(</tt><tt class="py-param">maxSize</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="_media_size_to_long-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_media_size_to_long-expanded"><a name="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert a string media size, such as 10GB or 3TB into an integer.</tt> </tt>
-<a name="L400"></a><tt class="py-lineno"> 400</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"><tt class="py-docstring"> maxSize: string, size as a string, such as 2MB or 7GB.</tt> </tt>
-<a name="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"><tt class="py-docstring"> The size as an integer value.</tt> </tt>
-<a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">maxSize</tt><tt class="py-op">)</tt> <tt class="py-op"><</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
-<a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-number">0</tt> </tt>
-<a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"> <tt class="py-name">units</tt> <tt class="py-op">=</tt> <tt class="py-name">maxSize</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">upper</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"> <tt class="py-name">bit_shift</tt> <tt class="py-op">=</tt> <tt id="link-124" class="py-name"><a title="googleapiclient.discovery._MEDIA_SIZE_BIT_SHIFTS" class="py-name" href="#" onclick="return doclink('link-124', '_MEDIA_SIZE_BIT_SHIFTS', 'link-53');">_MEDIA_SIZE_BIT_SHIFTS</a></tt><tt class="py-op">.</tt><tt id="link-125" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-119', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'features'</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"> <tt id="link-120" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-120', 'model', 'link-39');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-121" class="py-name"><a title="googleapiclient.model.JsonModel" class="py-name" href="#" onclick="return doclink('link-121', 'JsonModel', 'link-40');">JsonModel</a></tt><tt class="py-op">(</tt><tt class="py-string">'dataWrapper'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">features</tt><tt class="py-op">)</tt> </tt>
+<a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-122" class="py-name" targets="Class googleapiclient.discovery.Resource=googleapiclient.discovery.Resource-class.html"><a title="googleapiclient.discovery.Resource" class="py-name" href="#" onclick="return doclink('link-122', 'Resource', 'link-122');">Resource</a></tt><tt class="py-op">(</tt><tt id="link-123" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-123', 'http', 'link-21');">http</a></tt><tt class="py-op">=</tt><tt id="link-124" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-124', 'http', 'link-21');">http</a></tt><tt class="py-op">,</tt> <tt class="py-name">baseUrl</tt><tt class="py-op">=</tt><tt id="link-125" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-125', 'base', 'link-76');">base</a></tt><tt class="py-op">,</tt> <tt id="link-126" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-126', 'model', 'link-39');">model</a></tt><tt class="py-op">=</tt><tt id="link-127" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-127', 'model', 'link-39');">model</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"> <tt class="py-name">developerKey</tt><tt class="py-op">=</tt><tt class="py-name">developerKey</tt><tt class="py-op">,</tt> <tt class="py-name">requestBuilder</tt><tt class="py-op">=</tt><tt class="py-name">requestBuilder</tt><tt class="py-op">,</tt> </tt>
+<a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"> <tt class="py-name">resourceDesc</tt><tt class="py-op">=</tt><tt class="py-name">service</tt><tt class="py-op">,</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">=</tt><tt class="py-name">service</tt><tt class="py-op">,</tt> <tt id="link-128" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-128', 'schema', 'link-48');">schema</a></tt><tt class="py-op">=</tt><tt id="link-129" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-129', 'schema', 'link-48');">schema</a></tt><tt class="py-op">)</tt> </tt>
+</div><a name="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"> </tt>
+<a name="_cast"></a><div id="_cast-def"><a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"> </tt>
+<a name="L369"></a><tt class="py-lineno"> 369</tt> <a class="py-toggle" href="#" id="_cast-toggle" onclick="return toggle('_cast');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_cast">_cast</a><tt class="py-op">(</tt><tt class="py-param">value</tt><tt class="py-op">,</tt> <tt class="py-param">schema_type</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="_cast-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_cast-expanded"><a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert value to a string based on JSON Schema type.</tt> </tt>
+<a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"><tt class="py-docstring"> See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on</tt> </tt>
+<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"><tt class="py-docstring"> JSON Schema.</tt> </tt>
+<a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"><tt class="py-docstring"> value: any, the value to convert</tt> </tt>
+<a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"><tt class="py-docstring"> schema_type: string, the type that value should be interpreted as</tt> </tt>
+<a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L379"></a><tt class="py-lineno"> 379</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"><tt class="py-docstring"> A string representation of 'value' based on the schema_type.</tt> </tt>
+<a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">schema_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'string'</tt><tt class="py-op">:</tt> </tt>
+<a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-string">''</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-string">u''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">value</tt> </tt>
+<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
+<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">schema_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'integer'</tt><tt class="py-op">:</tt> </tt>
+<a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L389"></a><tt class="py-lineno"> 389</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">schema_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'number'</tt><tt class="py-op">:</tt> </tt>
+<a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">schema_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'boolean'</tt><tt class="py-op">:</tt> </tt>
+<a name="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">bool</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-string">''</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-string">u''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">value</tt> </tt>
+<a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L397"></a><tt class="py-lineno"> 397</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L398"></a><tt class="py-lineno"> 398</tt> <tt class="py-line"> </tt>
+<a name="_media_size_to_long"></a><div id="_media_size_to_long-def"><a name="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"> </tt>
+<a name="L400"></a><tt class="py-lineno"> 400</tt> <a class="py-toggle" href="#" id="_media_size_to_long-toggle" onclick="return toggle('_media_size_to_long');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_media_size_to_long">_media_size_to_long</a><tt class="py-op">(</tt><tt class="py-param">maxSize</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="_media_size_to_long-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_media_size_to_long-expanded"><a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert a string media size, such as 10GB or 3TB into an integer.</tt> </tt>
+<a name="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"><tt class="py-docstring"> maxSize: string, size as a string, such as 2MB or 7GB.</tt> </tt>
+<a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"><tt class="py-docstring"> The size as an integer value.</tt> </tt>
+<a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">maxSize</tt><tt class="py-op">)</tt> <tt class="py-op"><</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
+<a name="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-number">0</tt> </tt>
+<a name="L411"></a><tt class="py-lineno"> 411</tt> <tt class="py-line"> <tt class="py-name">units</tt> <tt class="py-op">=</tt> <tt class="py-name">maxSize</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">upper</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"> <tt class="py-name">bit_shift</tt> <tt class="py-op">=</tt> <tt id="link-130" class="py-name"><a title="googleapiclient.discovery._MEDIA_SIZE_BIT_SHIFTS" class="py-name" href="#" onclick="return doclink('link-130', '_MEDIA_SIZE_BIT_SHIFTS', 'link-59');">_MEDIA_SIZE_BIT_SHIFTS</a></tt><tt class="py-op">.</tt><tt id="link-131" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-125', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">units</tt><tt class="py-op">)</tt> </tt>
-<a name="L411"></a><tt class="py-lineno"> 411</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">bit_shift</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">maxSize</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op"><<</tt> <tt class="py-name">bit_shift</tt> </tt>
-<a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L414"></a><tt class="py-lineno"> 414</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">maxSize</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"> </tt>
-<a name="_media_path_url_from_info"></a><div id="_media_path_url_from_info-def"><a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"> </tt>
-<a name="L417"></a><tt class="py-lineno"> 417</tt> <a class="py-toggle" href="#" id="_media_path_url_from_info-toggle" onclick="return toggle('_media_path_url_from_info');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_media_path_url_from_info">_media_path_url_from_info</a><tt class="py-op">(</tt><tt class="py-param">root_desc</tt><tt class="py-op">,</tt> <tt class="py-param">path_url</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="_media_path_url_from_info-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_media_path_url_from_info-expanded"><a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates an absolute media path URL.</tt> </tt>
-<a name="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"><tt class="py-docstring"> Constructed using the API root URI and service path from the discovery</tt> </tt>
-<a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"><tt class="py-docstring"> document and the relative path for the API method.</tt> </tt>
-<a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
-<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"><tt class="py-docstring"> path_url: String; the relative URL for the API method. Relative to the API</tt> </tt>
-<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"><tt class="py-docstring"> root, which is specified in the discovery document.</tt> </tt>
-<a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L429"></a><tt class="py-lineno"> 429</tt> <tt class="py-line"><tt class="py-docstring"> String; the absolute URI for media upload for the API method.</tt> </tt>
-<a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L431"></a><tt class="py-lineno"> 431</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%(root)supload/%(service_path)s%(path)s'</tt> <tt class="py-op">%</tt> <tt class="py-op">{</tt> </tt>
-<a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"> <tt class="py-string">'root'</tt><tt class="py-op">:</tt> <tt class="py-name">root_desc</tt><tt class="py-op">[</tt><tt class="py-string">'rootUrl'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
-<a name="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"> <tt class="py-string">'service_path'</tt><tt class="py-op">:</tt> <tt class="py-name">root_desc</tt><tt class="py-op">[</tt><tt class="py-string">'servicePath'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
-<a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"> <tt class="py-string">'path'</tt><tt class="py-op">:</tt> <tt class="py-name">path_url</tt><tt class="py-op">,</tt> </tt>
-<a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
-</div><a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"> </tt>
-<a name="_fix_up_parameters"></a><div id="_fix_up_parameters-def"><a name="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"> </tt>
-<a name="L438"></a><tt class="py-lineno"> 438</tt> <a class="py-toggle" href="#" id="_fix_up_parameters-toggle" onclick="return toggle('_fix_up_parameters');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_fix_up_parameters">_fix_up_parameters</a><tt class="py-op">(</tt><tt class="py-param">method_desc</tt><tt class="py-op">,</tt> <tt class="py-param">root_desc</tt><tt class="py-op">,</tt> <tt class="py-param">http_method</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="_fix_up_parameters-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_fix_up_parameters-expanded"><a name="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"> <tt class="py-docstring">"""Updates parameters of an API method with values specific to this library.</tt> </tt>
-<a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"><tt class="py-docstring"> Specifically, adds whatever global parameters are specified by the API to the</tt> </tt>
-<a name="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"><tt class="py-docstring"> parameters for the individual method. Also adds parameters which don't</tt> </tt>
-<a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"><tt class="py-docstring"> appear in the discovery document, but are available to all discovery based</tt> </tt>
-<a name="L444"></a><tt class="py-lineno"> 444</tt> <tt class="py-line"><tt class="py-docstring"> APIs (these are listed in STACK_QUERY_PARAMETERS).</tt> </tt>
-<a name="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"><tt class="py-docstring"> SIDE EFFECTS: This updates the parameters dictionary object in the method</tt> </tt>
-<a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"><tt class="py-docstring"> description.</tt> </tt>
-<a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value comes</tt> </tt>
-<a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"><tt class="py-docstring"> from the dictionary of methods stored in the 'methods' key in the</tt> </tt>
-<a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"><tt class="py-docstring"> deserialized discovery document.</tt> </tt>
-<a name="L453"></a><tt class="py-lineno"> 453</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
-<a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"><tt class="py-docstring"> http_method: String; the HTTP method used to call the API method described</tt> </tt>
-<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"><tt class="py-docstring"> in method_desc.</tt> </tt>
-<a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"><tt class="py-docstring"> The updated Dictionary stored in the 'parameters' key of the method</tt> </tt>
-<a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"><tt class="py-docstring"> description dictionary.</tt> </tt>
-<a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"> <tt class="py-name">parameters</tt> <tt class="py-op">=</tt> <tt class="py-name">method_desc</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-string">'parameters'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
-<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"> </tt>
-<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"> <tt class="py-comment"># Add in the parameters common to all methods.</tt> </tt>
-<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">description</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">root_desc</tt><tt class="py-op">.</tt><tt id="link-126" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-131', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">units</tt><tt class="py-op">)</tt> </tt>
+<a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">bit_shift</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L414"></a><tt class="py-lineno"> 414</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">maxSize</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op"><<</tt> <tt class="py-name">bit_shift</tt> </tt>
+<a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">maxSize</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L417"></a><tt class="py-lineno"> 417</tt> <tt class="py-line"> </tt>
+<a name="_media_path_url_from_info"></a><div id="_media_path_url_from_info-def"><a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"> </tt>
+<a name="L419"></a><tt class="py-lineno"> 419</tt> <a class="py-toggle" href="#" id="_media_path_url_from_info-toggle" onclick="return toggle('_media_path_url_from_info');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_media_path_url_from_info">_media_path_url_from_info</a><tt class="py-op">(</tt><tt class="py-param">root_desc</tt><tt class="py-op">,</tt> <tt class="py-param">path_url</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="_media_path_url_from_info-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_media_path_url_from_info-expanded"><a name="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates an absolute media path URL.</tt> </tt>
+<a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"><tt class="py-docstring"> Constructed using the API root URI and service path from the discovery</tt> </tt>
+<a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"><tt class="py-docstring"> document and the relative path for the API method.</tt> </tt>
+<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
+<a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"><tt class="py-docstring"> path_url: String; the relative URL for the API method. Relative to the API</tt> </tt>
+<a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"><tt class="py-docstring"> root, which is specified in the discovery document.</tt> </tt>
+<a name="L429"></a><tt class="py-lineno"> 429</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L431"></a><tt class="py-lineno"> 431</tt> <tt class="py-line"><tt class="py-docstring"> String; the absolute URI for media upload for the API method.</tt> </tt>
+<a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%(root)supload/%(service_path)s%(path)s'</tt> <tt class="py-op">%</tt> <tt class="py-op">{</tt> </tt>
+<a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"> <tt class="py-string">'root'</tt><tt class="py-op">:</tt> <tt class="py-name">root_desc</tt><tt class="py-op">[</tt><tt class="py-string">'rootUrl'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
+<a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"> <tt class="py-string">'service_path'</tt><tt class="py-op">:</tt> <tt class="py-name">root_desc</tt><tt class="py-op">[</tt><tt class="py-string">'servicePath'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
+<a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"> <tt class="py-string">'path'</tt><tt class="py-op">:</tt> <tt class="py-name">path_url</tt><tt class="py-op">,</tt> </tt>
+<a name="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
+</div><a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"> </tt>
+<a name="_fix_up_parameters"></a><div id="_fix_up_parameters-def"><a name="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"> </tt>
+<a name="L440"></a><tt class="py-lineno"> 440</tt> <a class="py-toggle" href="#" id="_fix_up_parameters-toggle" onclick="return toggle('_fix_up_parameters');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_fix_up_parameters">_fix_up_parameters</a><tt class="py-op">(</tt><tt class="py-param">method_desc</tt><tt class="py-op">,</tt> <tt class="py-param">root_desc</tt><tt class="py-op">,</tt> <tt class="py-param">http_method</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="_fix_up_parameters-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_fix_up_parameters-expanded"><a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"> <tt class="py-docstring">"""Updates parameters of an API method with values specific to this library.</tt> </tt>
+<a name="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"><tt class="py-docstring"> Specifically, adds whatever global parameters are specified by the API to the</tt> </tt>
+<a name="L444"></a><tt class="py-lineno"> 444</tt> <tt class="py-line"><tt class="py-docstring"> parameters for the individual method. Also adds parameters which don't</tt> </tt>
+<a name="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"><tt class="py-docstring"> appear in the discovery document, but are available to all discovery based</tt> </tt>
+<a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"><tt class="py-docstring"> APIs (these are listed in STACK_QUERY_PARAMETERS).</tt> </tt>
+<a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"><tt class="py-docstring"> SIDE EFFECTS: This updates the parameters dictionary object in the method</tt> </tt>
+<a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"><tt class="py-docstring"> description.</tt> </tt>
+<a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value comes</tt> </tt>
+<a name="L453"></a><tt class="py-lineno"> 453</tt> <tt class="py-line"><tt class="py-docstring"> from the dictionary of methods stored in the 'methods' key in the</tt> </tt>
+<a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"><tt class="py-docstring"> deserialized discovery document.</tt> </tt>
+<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
+<a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"><tt class="py-docstring"> http_method: String; the HTTP method used to call the API method described</tt> </tt>
+<a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"><tt class="py-docstring"> in method_desc.</tt> </tt>
+<a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"><tt class="py-docstring"> The updated Dictionary stored in the 'parameters' key of the method</tt> </tt>
+<a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"><tt class="py-docstring"> description dictionary.</tt> </tt>
+<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"> <tt class="py-name">parameters</tt> <tt class="py-op">=</tt> <tt class="py-name">method_desc</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-string">'parameters'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
+<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"> </tt>
+<a name="L465"></a><tt class="py-lineno"> 465</tt> <tt class="py-line"> <tt class="py-comment"># Add in the parameters common to all methods.</tt> </tt>
+<a name="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">description</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">root_desc</tt><tt class="py-op">.</tt><tt id="link-132" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-126', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'parameters'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L465"></a><tt class="py-lineno"> 465</tt> <tt class="py-line"> <tt class="py-name">parameters</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">description</tt> </tt>
-<a name="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"> </tt>
-<a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"> <tt class="py-comment"># Add in undocumented query parameters.</tt> </tt>
-<a name="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt id="link-127" class="py-name"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETERS" class="py-name" href="#" onclick="return doclink('link-127', 'STACK_QUERY_PARAMETERS', 'link-56');">STACK_QUERY_PARAMETERS</a></tt><tt class="py-op">:</tt> </tt>
-<a name="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"> <tt class="py-name">parameters</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-128" class="py-name"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-128', 'STACK_QUERY_PARAMETER_DEFAULT_VALUE', 'link-57');">STACK_QUERY_PARAMETER_DEFAULT_VALUE</a></tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"> </tt>
-<a name="L471"></a><tt class="py-lineno"> 471</tt> <tt class="py-line"> <tt class="py-comment"># Add 'body' (our own reserved word) to parameters if the method supports</tt> </tt>
-<a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"> <tt class="py-comment"># a request payload.</tt> </tt>
-<a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">http_method</tt> <tt class="py-keyword">in</tt> <tt id="link-129" class="py-name"><a title="googleapiclient.discovery.HTTP_PAYLOAD_METHODS" class="py-name" href="#" onclick="return doclink('link-129', 'HTTP_PAYLOAD_METHODS', 'link-52');">HTTP_PAYLOAD_METHODS</a></tt> <tt class="py-keyword">and</tt> <tt class="py-string">'request'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">method_desc</tt><tt class="py-op">:</tt> </tt>
-<a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"> <tt id="link-130" class="py-name" targets="Method googleapiclient.channel.Channel.body()=googleapiclient.channel.Channel-class.html#body"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-130', 'body', 'link-130');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-131" class="py-name"><a title="googleapiclient.discovery.BODY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-131', 'BODY_PARAMETER_DEFAULT_VALUE', 'link-54');">BODY_PARAMETER_DEFAULT_VALUE</a></tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"> <tt id="link-132" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-132', 'body', 'link-130');">body</a></tt><tt class="py-op">.</tt><tt id="link-133" class="py-name" targets="Method googleapiclient.channel.Channel.update()=googleapiclient.channel.Channel-class.html#update"><a title="googleapiclient.channel.Channel.update" class="py-name" href="#" onclick="return doclink('link-133', 'update', 'link-133');">update</a></tt><tt class="py-op">(</tt><tt class="py-name">method_desc</tt><tt class="py-op">[</tt><tt class="py-string">'request'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"> <tt class="py-name">parameters</tt><tt class="py-op">[</tt><tt class="py-string">'body'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-134" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-134', 'body', 'link-130');">body</a></tt> </tt>
-<a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"> </tt>
-<a name="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parameters</tt> </tt>
-</div><a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"> </tt>
-<a name="_fix_up_media_upload"></a><div id="_fix_up_media_upload-def"><a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"> </tt>
-<a name="L481"></a><tt class="py-lineno"> 481</tt> <a class="py-toggle" href="#" id="_fix_up_media_upload-toggle" onclick="return toggle('_fix_up_media_upload');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_fix_up_media_upload">_fix_up_media_upload</a><tt class="py-op">(</tt><tt class="py-param">method_desc</tt><tt class="py-op">,</tt> <tt class="py-param">root_desc</tt><tt class="py-op">,</tt> <tt class="py-param">path_url</tt><tt class="py-op">,</tt> <tt class="py-param">parameters</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="_fix_up_media_upload-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_fix_up_media_upload-expanded"><a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"> <tt class="py-docstring">"""Updates parameters of API by adding 'media_body' if supported by method.</tt> </tt>
-<a name="L483"></a><tt class="py-lineno"> 483</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"><tt class="py-docstring"> SIDE EFFECTS: If the method supports media upload and has a required body,</tt> </tt>
-<a name="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"><tt class="py-docstring"> sets body to be optional (required=False) instead. Also, if there is a</tt> </tt>
-<a name="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"><tt class="py-docstring"> 'mediaUpload' in the method description, adds 'media_upload' key to</tt> </tt>
-<a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"><tt class="py-docstring"> parameters.</tt> </tt>
-<a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L489"></a><tt class="py-lineno"> 489</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value comes</tt> </tt>
-<a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"><tt class="py-docstring"> from the dictionary of methods stored in the 'methods' key in the</tt> </tt>
-<a name="L492"></a><tt class="py-lineno"> 492</tt> <tt class="py-line"><tt class="py-docstring"> deserialized discovery document.</tt> </tt>
-<a name="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
-<a name="L494"></a><tt class="py-lineno"> 494</tt> <tt class="py-line"><tt class="py-docstring"> path_url: String; the relative URL for the API method. Relative to the API</tt> </tt>
-<a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"><tt class="py-docstring"> root, which is specified in the discovery document.</tt> </tt>
-<a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"><tt class="py-docstring"> parameters: A dictionary describing method parameters for method described</tt> </tt>
-<a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"><tt class="py-docstring"> in method_desc.</tt> </tt>
-<a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L500"></a><tt class="py-lineno"> 500</tt> <tt class="py-line"><tt class="py-docstring"> Triple (accept, max_size, media_path_url) where:</tt> </tt>
-<a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"><tt class="py-docstring"> - accept is a list of strings representing what content types are</tt> </tt>
-<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"><tt class="py-docstring"> accepted for media upload. Defaults to empty list if not in the</tt> </tt>
-<a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"><tt class="py-docstring"> discovery document.</tt> </tt>
-<a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"><tt class="py-docstring"> - max_size is a long representing the max size in bytes allowed for a</tt> </tt>
-<a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"><tt class="py-docstring"> media upload. Defaults to 0L if not in the discovery document.</tt> </tt>
-<a name="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"><tt class="py-docstring"> - media_path_url is a String; the absolute URI for media upload for the</tt> </tt>
-<a name="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"><tt class="py-docstring"> API method. Constructed using the API root URI and service path from</tt> </tt>
-<a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"><tt class="py-docstring"> the discovery document and the relative path for the API method. If</tt> </tt>
-<a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"><tt class="py-docstring"> media upload is not supported, this is None.</tt> </tt>
-<a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"> <tt class="py-name">media_upload</tt> <tt class="py-op">=</tt> <tt class="py-name">method_desc</tt><tt class="py-op">.</tt><tt id="link-135" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-132', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'parameters'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"> <tt class="py-name">parameters</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">description</tt> </tt>
+<a name="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"> </tt>
+<a name="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"> <tt class="py-comment"># Add in undocumented query parameters.</tt> </tt>
+<a name="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt id="link-133" class="py-name"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETERS" class="py-name" href="#" onclick="return doclink('link-133', 'STACK_QUERY_PARAMETERS', 'link-62');">STACK_QUERY_PARAMETERS</a></tt><tt class="py-op">:</tt> </tt>
+<a name="L471"></a><tt class="py-lineno"> 471</tt> <tt class="py-line"> <tt class="py-name">parameters</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-134" class="py-name"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-134', 'STACK_QUERY_PARAMETER_DEFAULT_VALUE', 'link-63');">STACK_QUERY_PARAMETER_DEFAULT_VALUE</a></tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"> </tt>
+<a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"> <tt class="py-comment"># Add 'body' (our own reserved word) to parameters if the method supports</tt> </tt>
+<a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"> <tt class="py-comment"># a request payload.</tt> </tt>
+<a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">http_method</tt> <tt class="py-keyword">in</tt> <tt id="link-135" class="py-name"><a title="googleapiclient.discovery.HTTP_PAYLOAD_METHODS" class="py-name" href="#" onclick="return doclink('link-135', 'HTTP_PAYLOAD_METHODS', 'link-58');">HTTP_PAYLOAD_METHODS</a></tt> <tt class="py-keyword">and</tt> <tt class="py-string">'request'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">method_desc</tt><tt class="py-op">:</tt> </tt>
+<a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"> <tt id="link-136" class="py-name" targets="Method googleapiclient.channel.Channel.body()=googleapiclient.channel.Channel-class.html#body"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-136', 'body', 'link-136');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-137" class="py-name"><a title="googleapiclient.discovery.BODY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-137', 'BODY_PARAMETER_DEFAULT_VALUE', 'link-60');">BODY_PARAMETER_DEFAULT_VALUE</a></tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"> <tt id="link-138" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-138', 'body', 'link-136');">body</a></tt><tt class="py-op">.</tt><tt id="link-139" class="py-name" targets="Method googleapiclient.channel.Channel.update()=googleapiclient.channel.Channel-class.html#update"><a title="googleapiclient.channel.Channel.update" class="py-name" href="#" onclick="return doclink('link-139', 'update', 'link-139');">update</a></tt><tt class="py-op">(</tt><tt class="py-name">method_desc</tt><tt class="py-op">[</tt><tt class="py-string">'request'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"> <tt class="py-name">parameters</tt><tt class="py-op">[</tt><tt class="py-string">'body'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-140" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-140', 'body', 'link-136');">body</a></tt> </tt>
+<a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"> </tt>
+<a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parameters</tt> </tt>
+</div><a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"> </tt>
+<a name="_fix_up_media_upload"></a><div id="_fix_up_media_upload-def"><a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"> </tt>
+<a name="L483"></a><tt class="py-lineno"> 483</tt> <a class="py-toggle" href="#" id="_fix_up_media_upload-toggle" onclick="return toggle('_fix_up_media_upload');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_fix_up_media_upload">_fix_up_media_upload</a><tt class="py-op">(</tt><tt class="py-param">method_desc</tt><tt class="py-op">,</tt> <tt class="py-param">root_desc</tt><tt class="py-op">,</tt> <tt class="py-param">path_url</tt><tt class="py-op">,</tt> <tt class="py-param">parameters</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="_fix_up_media_upload-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_fix_up_media_upload-expanded"><a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"> <tt class="py-docstring">"""Updates parameters of API by adding 'media_body' if supported by method.</tt> </tt>
+<a name="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"><tt class="py-docstring"> SIDE EFFECTS: If the method supports media upload and has a required body,</tt> </tt>
+<a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"><tt class="py-docstring"> sets body to be optional (required=False) instead. Also, if there is a</tt> </tt>
+<a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"><tt class="py-docstring"> 'mediaUpload' in the method description, adds 'media_upload' key to</tt> </tt>
+<a name="L489"></a><tt class="py-lineno"> 489</tt> <tt class="py-line"><tt class="py-docstring"> parameters.</tt> </tt>
+<a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L492"></a><tt class="py-lineno"> 492</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value comes</tt> </tt>
+<a name="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"><tt class="py-docstring"> from the dictionary of methods stored in the 'methods' key in the</tt> </tt>
+<a name="L494"></a><tt class="py-lineno"> 494</tt> <tt class="py-line"><tt class="py-docstring"> deserialized discovery document.</tt> </tt>
+<a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
+<a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"><tt class="py-docstring"> path_url: String; the relative URL for the API method. Relative to the API</tt> </tt>
+<a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"><tt class="py-docstring"> root, which is specified in the discovery document.</tt> </tt>
+<a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"><tt class="py-docstring"> parameters: A dictionary describing method parameters for method described</tt> </tt>
+<a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"><tt class="py-docstring"> in method_desc.</tt> </tt>
+<a name="L500"></a><tt class="py-lineno"> 500</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"><tt class="py-docstring"> Triple (accept, max_size, media_path_url) where:</tt> </tt>
+<a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"><tt class="py-docstring"> - accept is a list of strings representing what content types are</tt> </tt>
+<a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"><tt class="py-docstring"> accepted for media upload. Defaults to empty list if not in the</tt> </tt>
+<a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"><tt class="py-docstring"> discovery document.</tt> </tt>
+<a name="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"><tt class="py-docstring"> - max_size is a long representing the max size in bytes allowed for a</tt> </tt>
+<a name="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"><tt class="py-docstring"> media upload. Defaults to 0L if not in the discovery document.</tt> </tt>
+<a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"><tt class="py-docstring"> - media_path_url is a String; the absolute URI for media upload for the</tt> </tt>
+<a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"><tt class="py-docstring"> API method. Constructed using the API root URI and service path from</tt> </tt>
+<a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"><tt class="py-docstring"> the discovery document and the relative path for the API method. If</tt> </tt>
+<a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"><tt class="py-docstring"> media upload is not supported, this is None.</tt> </tt>
+<a name="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"> <tt class="py-name">media_upload</tt> <tt class="py-op">=</tt> <tt class="py-name">method_desc</tt><tt class="py-op">.</tt><tt id="link-141" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-135', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'mediaUpload'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
-<a name="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"> <tt id="link-136" class="py-name" targets="Variable googleapiclient.model.BaseModel.accept=googleapiclient.model.BaseModel-class.html#accept,Variable googleapiclient.model.JsonModel.accept=googleapiclient.model.JsonModel-class.html#accept,Variable googleapiclient.model.MediaModel.accept=googleapiclient.model.MediaModel-class.html#accept,Variable googleapiclient.model.ProtocolBufferModel.accept=googleapiclient.model.ProtocolBufferModel-class.html#accept,Variable googleapiclient.model.RawModel.accept=googleapiclient.model.RawModel-class.html#accept"><a title="googleapiclient.model.BaseModel.accept
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-141', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'mediaUpload'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
+<a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"> <tt id="link-142" class="py-name" targets="Variable googleapiclient.model.BaseModel.accept=googleapiclient.model.BaseModel-class.html#accept,Variable googleapiclient.model.JsonModel.accept=googleapiclient.model.JsonModel-class.html#accept,Variable googleapiclient.model.MediaModel.accept=googleapiclient.model.MediaModel-class.html#accept,Variable googleapiclient.model.ProtocolBufferModel.accept=googleapiclient.model.ProtocolBufferModel-class.html#accept,Variable googleapiclient.model.RawModel.accept=googleapiclient.model.RawModel-class.html#accept"><a title="googleapiclient.model.BaseModel.accept
googleapiclient.model.JsonModel.accept
googleapiclient.model.MediaModel.accept
googleapiclient.model.ProtocolBufferModel.accept
-googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-136', 'accept', 'link-136');">accept</a></tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-137" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-142', 'accept', 'link-142');">accept</a></tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-143" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-137', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'accept'</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"> <tt class="py-name">max_size</tt> <tt class="py-op">=</tt> <tt id="link-138" class="py-name" targets="Function googleapiclient.discovery._media_size_to_long()=googleapiclient.discovery-module.html#_media_size_to_long"><a title="googleapiclient.discovery._media_size_to_long" class="py-name" href="#" onclick="return doclink('link-138', '_media_size_to_long', 'link-138');">_media_size_to_long</a></tt><tt class="py-op">(</tt><tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-139" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-143', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'accept'</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"> <tt class="py-name">max_size</tt> <tt class="py-op">=</tt> <tt id="link-144" class="py-name" targets="Function googleapiclient.discovery._media_size_to_long()=googleapiclient.discovery-module.html#_media_size_to_long"><a title="googleapiclient.discovery._media_size_to_long" class="py-name" href="#" onclick="return doclink('link-144', '_media_size_to_long', 'link-144');">_media_size_to_long</a></tt><tt class="py-op">(</tt><tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-145" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-139', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'maxSize'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"> <tt class="py-name">media_path_url</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
-<a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"> </tt>
-<a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">media_upload</tt><tt class="py-op">:</tt> </tt>
-<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"> <tt class="py-name">media_path_url</tt> <tt class="py-op">=</tt> <tt id="link-140" class="py-name" targets="Function googleapiclient.discovery._media_path_url_from_info()=googleapiclient.discovery-module.html#_media_path_url_from_info"><a title="googleapiclient.discovery._media_path_url_from_info" class="py-name" href="#" onclick="return doclink('link-140', '_media_path_url_from_info', 'link-140');">_media_path_url_from_info</a></tt><tt class="py-op">(</tt><tt class="py-name">root_desc</tt><tt class="py-op">,</tt> <tt class="py-name">path_url</tt><tt class="py-op">)</tt> </tt>
-<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"> <tt class="py-name">parameters</tt><tt class="py-op">[</tt><tt class="py-string">'media_body'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-141" class="py-name"><a title="googleapiclient.discovery.MEDIA_BODY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-141', 'MEDIA_BODY_PARAMETER_DEFAULT_VALUE', 'link-55');">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</a></tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'body'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">:</tt> </tt>
-<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"> <tt class="py-name">parameters</tt><tt class="py-op">[</tt><tt class="py-string">'body'</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-string">'required'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
-<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"> </tt>
-<a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-142" class="py-name"><a title="googleapiclient.model.BaseModel.accept
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-145', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'maxSize'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"> <tt class="py-name">media_path_url</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
+<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"> </tt>
+<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">media_upload</tt><tt class="py-op">:</tt> </tt>
+<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"> <tt class="py-name">media_path_url</tt> <tt class="py-op">=</tt> <tt id="link-146" class="py-name" targets="Function googleapiclient.discovery._media_path_url_from_info()=googleapiclient.discovery-module.html#_media_path_url_from_info"><a title="googleapiclient.discovery._media_path_url_from_info" class="py-name" href="#" onclick="return doclink('link-146', '_media_path_url_from_info', 'link-146');">_media_path_url_from_info</a></tt><tt class="py-op">(</tt><tt class="py-name">root_desc</tt><tt class="py-op">,</tt> <tt class="py-name">path_url</tt><tt class="py-op">)</tt> </tt>
+<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"> <tt class="py-name">parameters</tt><tt class="py-op">[</tt><tt class="py-string">'media_body'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-147" class="py-name"><a title="googleapiclient.discovery.MEDIA_BODY_PARAMETER_DEFAULT_VALUE" class="py-name" href="#" onclick="return doclink('link-147', 'MEDIA_BODY_PARAMETER_DEFAULT_VALUE', 'link-61');">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</a></tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'body'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">:</tt> </tt>
+<a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"> <tt class="py-name">parameters</tt><tt class="py-op">[</tt><tt class="py-string">'body'</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-string">'required'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
+<a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"> </tt>
+<a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-148" class="py-name"><a title="googleapiclient.model.BaseModel.accept
googleapiclient.model.JsonModel.accept
googleapiclient.model.MediaModel.accept
googleapiclient.model.ProtocolBufferModel.accept
-googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-142', 'accept', 'link-136');">accept</a></tt><tt class="py-op">,</tt> <tt class="py-name">max_size</tt><tt class="py-op">,</tt> <tt class="py-name">media_path_url</tt> </tt>
-</div><a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"> </tt>
-<a name="_fix_up_method_description"></a><div id="_fix_up_method_description-def"><a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"> </tt>
-<a name="L525"></a><tt class="py-lineno"> 525</tt> <a class="py-toggle" href="#" id="_fix_up_method_description-toggle" onclick="return toggle('_fix_up_method_description');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_fix_up_method_description">_fix_up_method_description</a><tt class="py-op">(</tt><tt class="py-param">method_desc</tt><tt class="py-op">,</tt> <tt class="py-param">root_desc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="_fix_up_method_description-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_fix_up_method_description-expanded"><a name="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"> <tt class="py-docstring">"""Updates a method description in a discovery document.</tt> </tt>
-<a name="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"><tt class="py-docstring"> SIDE EFFECTS: Changes the parameters dictionary in the method description with</tt> </tt>
-<a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"><tt class="py-docstring"> extra parameters which are used locally.</tt> </tt>
-<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L532"></a><tt class="py-lineno"> 532</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value comes</tt> </tt>
-<a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"><tt class="py-docstring"> from the dictionary of methods stored in the 'methods' key in the</tt> </tt>
-<a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"><tt class="py-docstring"> deserialized discovery document.</tt> </tt>
-<a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
-<a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"><tt class="py-docstring"> Tuple (path_url, http_method, method_id, accept, max_size, media_path_url)</tt> </tt>
-<a name="L539"></a><tt class="py-lineno"> 539</tt> <tt class="py-line"><tt class="py-docstring"> where:</tt> </tt>
-<a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"><tt class="py-docstring"> - path_url is a String; the relative URL for the API method. Relative to</tt> </tt>
-<a name="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"><tt class="py-docstring"> the API root, which is specified in the discovery document.</tt> </tt>
-<a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"><tt class="py-docstring"> - http_method is a String; the HTTP method used to call the API method</tt> </tt>
-<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"><tt class="py-docstring"> described in the method description.</tt> </tt>
-<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"><tt class="py-docstring"> - method_id is a String; the name of the RPC method associated with the</tt> </tt>
-<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"><tt class="py-docstring"> API method, and is in the method description in the 'id' key.</tt> </tt>
-<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"><tt class="py-docstring"> - accept is a list of strings representing what content types are</tt> </tt>
-<a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"><tt class="py-docstring"> accepted for media upload. Defaults to empty list if not in the</tt> </tt>
-<a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"><tt class="py-docstring"> discovery document.</tt> </tt>
-<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"><tt class="py-docstring"> - max_size is a long representing the max size in bytes allowed for a</tt> </tt>
-<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"><tt class="py-docstring"> media upload. Defaults to 0L if not in the discovery document.</tt> </tt>
-<a name="L551"></a><tt class="py-lineno"> 551</tt> <tt class="py-line"><tt class="py-docstring"> - media_path_url is a String; the absolute URI for media upload for the</tt> </tt>
-<a name="L552"></a><tt class="py-lineno"> 552</tt> <tt class="py-line"><tt class="py-docstring"> API method. Constructed using the API root URI and service path from</tt> </tt>
-<a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"><tt class="py-docstring"> the discovery document and the relative path for the API method. If</tt> </tt>
-<a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"><tt class="py-docstring"> media upload is not supported, this is None.</tt> </tt>
-<a name="L555"></a><tt class="py-lineno"> 555</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"> <tt class="py-name">path_url</tt> <tt class="py-op">=</tt> <tt class="py-name">method_desc</tt><tt class="py-op">[</tt><tt class="py-string">'path'</tt><tt class="py-op">]</tt> </tt>
-<a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"> <tt class="py-name">http_method</tt> <tt class="py-op">=</tt> <tt class="py-name">method_desc</tt><tt class="py-op">[</tt><tt class="py-string">'httpMethod'</tt><tt class="py-op">]</tt> </tt>
-<a name="L558"></a><tt class="py-lineno"> 558</tt> <tt class="py-line"> <tt class="py-name">method_id</tt> <tt class="py-op">=</tt> <tt class="py-name">method_desc</tt><tt class="py-op">[</tt><tt class="py-string">'id'</tt><tt class="py-op">]</tt> </tt>
-<a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"> </tt>
-<a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"> <tt class="py-name">parameters</tt> <tt class="py-op">=</tt> <tt id="link-143" class="py-name" targets="Function googleapiclient.discovery._fix_up_parameters()=googleapiclient.discovery-module.html#_fix_up_parameters"><a title="googleapiclient.discovery._fix_up_parameters" class="py-name" href="#" onclick="return doclink('link-143', '_fix_up_parameters', 'link-143');">_fix_up_parameters</a></tt><tt class="py-op">(</tt><tt class="py-name">method_desc</tt><tt class="py-op">,</tt> <tt class="py-name">root_desc</tt><tt class="py-op">,</tt> <tt class="py-name">http_method</tt><tt class="py-op">)</tt> </tt>
-<a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"> <tt class="py-comment"># Order is important. `_fix_up_media_upload` needs `method_desc` to have a</tt> </tt>
-<a name="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"> <tt class="py-comment"># 'parameters' key and needs to know if there is a 'body' parameter because it</tt> </tt>
-<a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"> <tt class="py-comment"># also sets a 'media_body' parameter.</tt> </tt>
-<a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"> <tt id="link-144" class="py-name"><a title="googleapiclient.model.BaseModel.accept
+googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-148', 'accept', 'link-142');">accept</a></tt><tt class="py-op">,</tt> <tt class="py-name">max_size</tt><tt class="py-op">,</tt> <tt class="py-name">media_path_url</tt> </tt>
+</div><a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"> </tt>
+<a name="_fix_up_method_description"></a><div id="_fix_up_method_description-def"><a name="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"> </tt>
+<a name="L527"></a><tt class="py-lineno"> 527</tt> <a class="py-toggle" href="#" id="_fix_up_method_description-toggle" onclick="return toggle('_fix_up_method_description');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_fix_up_method_description">_fix_up_method_description</a><tt class="py-op">(</tt><tt class="py-param">method_desc</tt><tt class="py-op">,</tt> <tt class="py-param">root_desc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="_fix_up_method_description-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_fix_up_method_description-expanded"><a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"> <tt class="py-docstring">"""Updates a method description in a discovery document.</tt> </tt>
+<a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"><tt class="py-docstring"> SIDE EFFECTS: Changes the parameters dictionary in the method description with</tt> </tt>
+<a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"><tt class="py-docstring"> extra parameters which are used locally.</tt> </tt>
+<a name="L532"></a><tt class="py-lineno"> 532</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value comes</tt> </tt>
+<a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"><tt class="py-docstring"> from the dictionary of methods stored in the 'methods' key in the</tt> </tt>
+<a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"><tt class="py-docstring"> deserialized discovery document.</tt> </tt>
+<a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"><tt class="py-docstring"> root_desc: Dictionary; the entire original deserialized discovery document.</tt> </tt>
+<a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L539"></a><tt class="py-lineno"> 539</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"><tt class="py-docstring"> Tuple (path_url, http_method, method_id, accept, max_size, media_path_url)</tt> </tt>
+<a name="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"><tt class="py-docstring"> where:</tt> </tt>
+<a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"><tt class="py-docstring"> - path_url is a String; the relative URL for the API method. Relative to</tt> </tt>
+<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"><tt class="py-docstring"> the API root, which is specified in the discovery document.</tt> </tt>
+<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"><tt class="py-docstring"> - http_method is a String; the HTTP method used to call the API method</tt> </tt>
+<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"><tt class="py-docstring"> described in the method description.</tt> </tt>
+<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"><tt class="py-docstring"> - method_id is a String; the name of the RPC method associated with the</tt> </tt>
+<a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"><tt class="py-docstring"> API method, and is in the method description in the 'id' key.</tt> </tt>
+<a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"><tt class="py-docstring"> - accept is a list of strings representing what content types are</tt> </tt>
+<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"><tt class="py-docstring"> accepted for media upload. Defaults to empty list if not in the</tt> </tt>
+<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"><tt class="py-docstring"> discovery document.</tt> </tt>
+<a name="L551"></a><tt class="py-lineno"> 551</tt> <tt class="py-line"><tt class="py-docstring"> - max_size is a long representing the max size in bytes allowed for a</tt> </tt>
+<a name="L552"></a><tt class="py-lineno"> 552</tt> <tt class="py-line"><tt class="py-docstring"> media upload. Defaults to 0L if not in the discovery document.</tt> </tt>
+<a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"><tt class="py-docstring"> - media_path_url is a String; the absolute URI for media upload for the</tt> </tt>
+<a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"><tt class="py-docstring"> API method. Constructed using the API root URI and service path from</tt> </tt>
+<a name="L555"></a><tt class="py-lineno"> 555</tt> <tt class="py-line"><tt class="py-docstring"> the discovery document and the relative path for the API method. If</tt> </tt>
+<a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"><tt class="py-docstring"> media upload is not supported, this is None.</tt> </tt>
+<a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L558"></a><tt class="py-lineno"> 558</tt> <tt class="py-line"> <tt class="py-name">path_url</tt> <tt class="py-op">=</tt> <tt class="py-name">method_desc</tt><tt class="py-op">[</tt><tt class="py-string">'path'</tt><tt class="py-op">]</tt> </tt>
+<a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"> <tt class="py-name">http_method</tt> <tt class="py-op">=</tt> <tt class="py-name">method_desc</tt><tt class="py-op">[</tt><tt class="py-string">'httpMethod'</tt><tt class="py-op">]</tt> </tt>
+<a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"> <tt class="py-name">method_id</tt> <tt class="py-op">=</tt> <tt class="py-name">method_desc</tt><tt class="py-op">[</tt><tt class="py-string">'id'</tt><tt class="py-op">]</tt> </tt>
+<a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"> </tt>
+<a name="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"> <tt class="py-name">parameters</tt> <tt class="py-op">=</tt> <tt id="link-149" class="py-name" targets="Function googleapiclient.discovery._fix_up_parameters()=googleapiclient.discovery-module.html#_fix_up_parameters"><a title="googleapiclient.discovery._fix_up_parameters" class="py-name" href="#" onclick="return doclink('link-149', '_fix_up_parameters', 'link-149');">_fix_up_parameters</a></tt><tt class="py-op">(</tt><tt class="py-name">method_desc</tt><tt class="py-op">,</tt> <tt class="py-name">root_desc</tt><tt class="py-op">,</tt> <tt class="py-name">http_method</tt><tt class="py-op">)</tt> </tt>
+<a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"> <tt class="py-comment"># Order is important. `_fix_up_media_upload` needs `method_desc` to have a</tt> </tt>
+<a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"> <tt class="py-comment"># 'parameters' key and needs to know if there is a 'body' parameter because it</tt> </tt>
+<a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"> <tt class="py-comment"># also sets a 'media_body' parameter.</tt> </tt>
+<a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"> <tt id="link-150" class="py-name"><a title="googleapiclient.model.BaseModel.accept
googleapiclient.model.JsonModel.accept
googleapiclient.model.MediaModel.accept
googleapiclient.model.ProtocolBufferModel.accept
-googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-144', 'accept', 'link-136');">accept</a></tt><tt class="py-op">,</tt> <tt class="py-name">max_size</tt><tt class="py-op">,</tt> <tt class="py-name">media_path_url</tt> <tt class="py-op">=</tt> <tt id="link-145" class="py-name" targets="Function googleapiclient.discovery._fix_up_media_upload()=googleapiclient.discovery-module.html#_fix_up_media_upload"><a title="googleapiclient.discovery._fix_up_media_upload" class="py-name" href="#" onclick="return doclink('link-145', '_fix_up_media_upload', 'link-145');">_fix_up_media_upload</a></tt><tt class="py-op">(</tt> </tt>
-<a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"> <tt class="py-name">method_desc</tt><tt class="py-op">,</tt> <tt class="py-name">root_desc</tt><tt class="py-op">,</tt> <tt class="py-name">path_url</tt><tt class="py-op">,</tt> <tt class="py-name">parameters</tt><tt class="py-op">)</tt> </tt>
-<a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"> </tt>
-<a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">path_url</tt><tt class="py-op">,</tt> <tt class="py-name">http_method</tt><tt class="py-op">,</tt> <tt class="py-name">method_id</tt><tt class="py-op">,</tt> <tt id="link-146" class="py-name"><a title="googleapiclient.model.BaseModel.accept
+googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-150', 'accept', 'link-142');">accept</a></tt><tt class="py-op">,</tt> <tt class="py-name">max_size</tt><tt class="py-op">,</tt> <tt class="py-name">media_path_url</tt> <tt class="py-op">=</tt> <tt id="link-151" class="py-name" targets="Function googleapiclient.discovery._fix_up_media_upload()=googleapiclient.discovery-module.html#_fix_up_media_upload"><a title="googleapiclient.discovery._fix_up_media_upload" class="py-name" href="#" onclick="return doclink('link-151', '_fix_up_media_upload', 'link-151');">_fix_up_media_upload</a></tt><tt class="py-op">(</tt> </tt>
+<a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"> <tt class="py-name">method_desc</tt><tt class="py-op">,</tt> <tt class="py-name">root_desc</tt><tt class="py-op">,</tt> <tt class="py-name">path_url</tt><tt class="py-op">,</tt> <tt class="py-name">parameters</tt><tt class="py-op">)</tt> </tt>
+<a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"> </tt>
+<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">path_url</tt><tt class="py-op">,</tt> <tt class="py-name">http_method</tt><tt class="py-op">,</tt> <tt class="py-name">method_id</tt><tt class="py-op">,</tt> <tt id="link-152" class="py-name"><a title="googleapiclient.model.BaseModel.accept
googleapiclient.model.JsonModel.accept
googleapiclient.model.MediaModel.accept
googleapiclient.model.ProtocolBufferModel.accept
-googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-146', 'accept', 'link-136');">accept</a></tt><tt class="py-op">,</tt> <tt class="py-name">max_size</tt><tt class="py-op">,</tt> <tt class="py-name">media_path_url</tt> </tt>
-</div><a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"> </tt>
-<a name="_urljoin"></a><div id="_urljoin-def"><a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"> </tt>
-<a name="L570"></a><tt class="py-lineno"> 570</tt> <a class="py-toggle" href="#" id="_urljoin-toggle" onclick="return toggle('_urljoin');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_urljoin">_urljoin</a><tt class="py-op">(</tt><tt class="py-param">base</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="_urljoin-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_urljoin-expanded"><a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"> <tt class="py-docstring">"""Custom urljoin replacement supporting : before / in url."""</tt> </tt>
-<a name="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"> <tt class="py-comment"># In general, it's unsafe to simply join base and url. However, for</tt> </tt>
-<a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"> <tt class="py-comment"># the case of discovery documents, we know:</tt> </tt>
-<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"> <tt class="py-comment"># * base will never contain params, query, or fragment</tt> </tt>
-<a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"> <tt class="py-comment"># * url will never contain a scheme or net_loc.</tt> </tt>
-<a name="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"> <tt class="py-comment"># In general, this means we can safely join on /; we just need to</tt> </tt>
-<a name="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"> <tt class="py-comment"># ensure we end up with precisely one / joining base and url. The</tt> </tt>
-<a name="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"> <tt class="py-comment"># exception here is the case of media uploads, where url will be an</tt> </tt>
-<a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"> <tt class="py-comment"># absolute url.</tt> </tt>
-<a name="L580"></a><tt class="py-lineno"> 580</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">url</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'http://'</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">url</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'https://'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">urljoin</tt><tt class="py-op">(</tt><tt id="link-147" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-147', 'base', 'link-70');">base</a></tt><tt class="py-op">,</tt> <tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
-<a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"> <tt class="py-name">new_base</tt> <tt class="py-op">=</tt> <tt id="link-148" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-148', 'base', 'link-70');">base</a></tt> <tt class="py-keyword">if</tt> <tt id="link-149" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-149', 'base', 'link-70');">base</a></tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">)</tt> <tt class="py-keyword">else</tt> <tt id="link-150" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-150', 'base', 'link-70');">base</a></tt> <tt class="py-op">+</tt> <tt class="py-string">'/'</tt> </tt>
-<a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"> <tt class="py-name">new_url</tt> <tt class="py-op">=</tt> <tt class="py-name">url</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-keyword">if</tt> <tt class="py-name">url</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">)</tt> <tt class="py-keyword">else</tt> <tt class="py-name">url</tt> </tt>
-<a name="L584"></a><tt class="py-lineno"> 584</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">new_base</tt> <tt class="py-op">+</tt> <tt class="py-name">new_url</tt> </tt>
-</div><a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"> </tt>
-<a name="ResourceMethodParameters"></a><div id="ResourceMethodParameters-def"><a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"> </tt>
-<a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"><tt class="py-comment"># TODO(dhermes): Convert this class to ResourceMethod and make it callable</tt> </tt>
-<a name="L588"></a><tt class="py-lineno"> 588</tt> <a class="py-toggle" href="#" id="ResourceMethodParameters-toggle" onclick="return toggle('ResourceMethodParameters');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.discovery.ResourceMethodParameters-class.html">ResourceMethodParameters</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="ResourceMethodParameters-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ResourceMethodParameters-expanded"><a name="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"> <tt class="py-docstring">"""Represents the parameters associated with a method.</tt> </tt>
-<a name="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"><tt class="py-docstring"> Attributes:</tt> </tt>
-<a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"><tt class="py-docstring"> argmap: Map from method parameter name (string) to query parameter name</tt> </tt>
-<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"><tt class="py-docstring"> (string).</tt> </tt>
-<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"><tt class="py-docstring"> required_params: List of required parameters (represented by parameter</tt> </tt>
-<a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"><tt class="py-docstring"> name as string).</tt> </tt>
-<a name="L596"></a><tt class="py-lineno"> 596</tt> <tt class="py-line"><tt class="py-docstring"> repeated_params: List of repeated parameters (represented by parameter</tt> </tt>
+googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-152', 'accept', 'link-142');">accept</a></tt><tt class="py-op">,</tt> <tt class="py-name">max_size</tt><tt class="py-op">,</tt> <tt class="py-name">media_path_url</tt> </tt>
+</div><a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"> </tt>
+<a name="_urljoin"></a><div id="_urljoin-def"><a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"> </tt>
+<a name="L572"></a><tt class="py-lineno"> 572</tt> <a class="py-toggle" href="#" id="_urljoin-toggle" onclick="return toggle('_urljoin');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#_urljoin">_urljoin</a><tt class="py-op">(</tt><tt class="py-param">base</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="_urljoin-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_urljoin-expanded"><a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"> <tt class="py-docstring">"""Custom urljoin replacement supporting : before / in url."""</tt> </tt>
+<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"> <tt class="py-comment"># In general, it's unsafe to simply join base and url. However, for</tt> </tt>
+<a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"> <tt class="py-comment"># the case of discovery documents, we know:</tt> </tt>
+<a name="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"> <tt class="py-comment"># * base will never contain params, query, or fragment</tt> </tt>
+<a name="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"> <tt class="py-comment"># * url will never contain a scheme or net_loc.</tt> </tt>
+<a name="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"> <tt class="py-comment"># In general, this means we can safely join on /; we just need to</tt> </tt>
+<a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"> <tt class="py-comment"># ensure we end up with precisely one / joining base and url. The</tt> </tt>
+<a name="L580"></a><tt class="py-lineno"> 580</tt> <tt class="py-line"> <tt class="py-comment"># exception here is the case of media uploads, where url will be an</tt> </tt>
+<a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"> <tt class="py-comment"># absolute url.</tt> </tt>
+<a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">url</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'http://'</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">url</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'https://'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">urljoin</tt><tt class="py-op">(</tt><tt id="link-153" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-153', 'base', 'link-76');">base</a></tt><tt class="py-op">,</tt> <tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
+<a name="L584"></a><tt class="py-lineno"> 584</tt> <tt class="py-line"> <tt class="py-name">new_base</tt> <tt class="py-op">=</tt> <tt id="link-154" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-154', 'base', 'link-76');">base</a></tt> <tt class="py-keyword">if</tt> <tt id="link-155" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-155', 'base', 'link-76');">base</a></tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">)</tt> <tt class="py-keyword">else</tt> <tt id="link-156" class="py-name"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-156', 'base', 'link-76');">base</a></tt> <tt class="py-op">+</tt> <tt class="py-string">'/'</tt> </tt>
+<a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"> <tt class="py-name">new_url</tt> <tt class="py-op">=</tt> <tt class="py-name">url</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-keyword">if</tt> <tt class="py-name">url</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">)</tt> <tt class="py-keyword">else</tt> <tt class="py-name">url</tt> </tt>
+<a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">new_base</tt> <tt class="py-op">+</tt> <tt class="py-name">new_url</tt> </tt>
+</div><a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"> </tt>
+<a name="ResourceMethodParameters"></a><div id="ResourceMethodParameters-def"><a name="L588"></a><tt class="py-lineno"> 588</tt> <tt class="py-line"> </tt>
+<a name="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"><tt class="py-comment"># TODO(dhermes): Convert this class to ResourceMethod and make it callable</tt> </tt>
+<a name="L590"></a><tt class="py-lineno"> 590</tt> <a class="py-toggle" href="#" id="ResourceMethodParameters-toggle" onclick="return toggle('ResourceMethodParameters');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.discovery.ResourceMethodParameters-class.html">ResourceMethodParameters</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="ResourceMethodParameters-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ResourceMethodParameters-expanded"><a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"> <tt class="py-docstring">"""Represents the parameters associated with a method.</tt> </tt>
+<a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"><tt class="py-docstring"> Attributes:</tt> </tt>
+<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"><tt class="py-docstring"> argmap: Map from method parameter name (string) to query parameter name</tt> </tt>
+<a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"><tt class="py-docstring"> (string).</tt> </tt>
+<a name="L596"></a><tt class="py-lineno"> 596</tt> <tt class="py-line"><tt class="py-docstring"> required_params: List of required parameters (represented by parameter</tt> </tt>
<a name="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"><tt class="py-docstring"> name as string).</tt> </tt>
-<a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"><tt class="py-docstring"> pattern_params: Map from method parameter name (string) to regular</tt> </tt>
-<a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"><tt class="py-docstring"> expression (as a string). If the pattern is set for a parameter, the</tt> </tt>
-<a name="L600"></a><tt class="py-lineno"> 600</tt> <tt class="py-line"><tt class="py-docstring"> value for that parameter must match the regular expression.</tt> </tt>
-<a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"><tt class="py-docstring"> query_params: List of parameters (represented by parameter name as string)</tt> </tt>
-<a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"><tt class="py-docstring"> that will be used in the query string.</tt> </tt>
-<a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"><tt class="py-docstring"> path_params: Set of parameters (represented by parameter name as string)</tt> </tt>
-<a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"><tt class="py-docstring"> that will be used in the base URL path.</tt> </tt>
-<a name="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"><tt class="py-docstring"> param_types: Map from method parameter name (string) to parameter type. Type</tt> </tt>
-<a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"><tt class="py-docstring"> can be any valid JSON schema type; valid values are 'any', 'array',</tt> </tt>
-<a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"><tt class="py-docstring"> 'boolean', 'integer', 'number', 'object', or 'string'. Reference:</tt> </tt>
-<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"><tt class="py-docstring"> http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1</tt> </tt>
-<a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"><tt class="py-docstring"> enum_params: Map from method parameter name (string) to list of strings,</tt> </tt>
-<a name="L610"></a><tt class="py-lineno"> 610</tt> <tt class="py-line"><tt class="py-docstring"> where each list of strings is the list of acceptable enum values.</tt> </tt>
-<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"> </tt>
-<a name="ResourceMethodParameters.__init__"></a><div id="ResourceMethodParameters.__init__-def"><a name="L613"></a><tt class="py-lineno"> 613</tt> <a class="py-toggle" href="#" id="ResourceMethodParameters.__init__-toggle" onclick="return toggle('ResourceMethodParameters.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.ResourceMethodParameters-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">method_desc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="ResourceMethodParameters.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="ResourceMethodParameters.__init__-expanded"><a name="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for ResourceMethodParameters.</tt> </tt>
-<a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"><tt class="py-docstring"> Sets default values and defers to set_parameters to populate.</tt> </tt>
+<a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"><tt class="py-docstring"> repeated_params: List of repeated parameters (represented by parameter</tt> </tt>
+<a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"><tt class="py-docstring"> name as string).</tt> </tt>
+<a name="L600"></a><tt class="py-lineno"> 600</tt> <tt class="py-line"><tt class="py-docstring"> pattern_params: Map from method parameter name (string) to regular</tt> </tt>
+<a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"><tt class="py-docstring"> expression (as a string). If the pattern is set for a parameter, the</tt> </tt>
+<a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"><tt class="py-docstring"> value for that parameter must match the regular expression.</tt> </tt>
+<a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"><tt class="py-docstring"> query_params: List of parameters (represented by parameter name as string)</tt> </tt>
+<a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"><tt class="py-docstring"> that will be used in the query string.</tt> </tt>
+<a name="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"><tt class="py-docstring"> path_params: Set of parameters (represented by parameter name as string)</tt> </tt>
+<a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"><tt class="py-docstring"> that will be used in the base URL path.</tt> </tt>
+<a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"><tt class="py-docstring"> param_types: Map from method parameter name (string) to parameter type. Type</tt> </tt>
+<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"><tt class="py-docstring"> can be any valid JSON schema type; valid values are 'any', 'array',</tt> </tt>
+<a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"><tt class="py-docstring"> 'boolean', 'integer', 'number', 'object', or 'string'. Reference:</tt> </tt>
+<a name="L610"></a><tt class="py-lineno"> 610</tt> <tt class="py-line"><tt class="py-docstring"> http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1</tt> </tt>
+<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"><tt class="py-docstring"> enum_params: Map from method parameter name (string) to list of strings,</tt> </tt>
+<a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"><tt class="py-docstring"> where each list of strings is the list of acceptable enum values.</tt> </tt>
+<a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"> </tt>
+<a name="ResourceMethodParameters.__init__"></a><div id="ResourceMethodParameters.__init__-def"><a name="L615"></a><tt class="py-lineno"> 615</tt> <a class="py-toggle" href="#" id="ResourceMethodParameters.__init__-toggle" onclick="return toggle('ResourceMethodParameters.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.ResourceMethodParameters-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">method_desc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="ResourceMethodParameters.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="ResourceMethodParameters.__init__-expanded"><a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for ResourceMethodParameters.</tt> </tt>
<a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value</tt> </tt>
-<a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"><tt class="py-docstring"> comes from the dictionary of methods stored in the 'methods' key in</tt> </tt>
-<a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"><tt class="py-docstring"> the deserialized discovery document.</tt> </tt>
-<a name="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L623"></a><tt class="py-lineno"> 623</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
-<a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">required_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
-<a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">repeated_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
-<a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pattern_params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
-<a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">query_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
-<a name="L628"></a><tt class="py-lineno"> 628</tt> <tt class="py-line"> <tt class="py-comment"># TODO(dhermes): Change path_params to a list if the extra URITEMPLATE</tt> </tt>
-<a name="L629"></a><tt class="py-lineno"> 629</tt> <tt class="py-line"> <tt class="py-comment"># parsing is gotten rid of.</tt> </tt>
-<a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">path_params</tt> <tt class="py-op">=</tt> <tt id="link-151" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.set
+<a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"><tt class="py-docstring"> Sets default values and defers to set_parameters to populate.</tt> </tt>
+<a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value</tt> </tt>
+<a name="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"><tt class="py-docstring"> comes from the dictionary of methods stored in the 'methods' key in</tt> </tt>
+<a name="L623"></a><tt class="py-lineno"> 623</tt> <tt class="py-line"><tt class="py-docstring"> the deserialized discovery document.</tt> </tt>
+<a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
+<a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">required_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
+<a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">repeated_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
+<a name="L628"></a><tt class="py-lineno"> 628</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pattern_params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
+<a name="L629"></a><tt class="py-lineno"> 629</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">query_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
+<a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"> <tt class="py-comment"># TODO(dhermes): Change path_params to a list if the extra URITEMPLATE</tt> </tt>
+<a name="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"> <tt class="py-comment"># parsing is gotten rid of.</tt> </tt>
+<a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">path_params</tt> <tt class="py-op">=</tt> <tt id="link-157" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.set
googleapiclient.discovery_cache.base.Cache.set
-googleapiclient.discovery_cache.file_cache.Cache.set" class="py-name" href="#" onclick="return doclink('link-151', 'set', 'link-95');">set</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">param_types</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
-<a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">enum_params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
-<a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"> </tt>
-<a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-152" class="py-name" targets="Method googleapiclient.discovery.ResourceMethodParameters.set_parameters()=googleapiclient.discovery.ResourceMethodParameters-class.html#set_parameters"><a title="googleapiclient.discovery.ResourceMethodParameters.set_parameters" class="py-name" href="#" onclick="return doclink('link-152', 'set_parameters', 'link-152');">set_parameters</a></tt><tt class="py-op">(</tt><tt class="py-name">method_desc</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"> </tt>
-<a name="ResourceMethodParameters.set_parameters"></a><div id="ResourceMethodParameters.set_parameters-def"><a name="L636"></a><tt class="py-lineno"> 636</tt> <a class="py-toggle" href="#" id="ResourceMethodParameters.set_parameters-toggle" onclick="return toggle('ResourceMethodParameters.set_parameters');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.ResourceMethodParameters-class.html#set_parameters">set_parameters</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">method_desc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="ResourceMethodParameters.set_parameters-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="ResourceMethodParameters.set_parameters-expanded"><a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"> <tt class="py-docstring">"""Populates maps and lists based on method description.</tt> </tt>
-<a name="L638"></a><tt class="py-lineno"> 638</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"><tt class="py-docstring"> Iterates through each parameter for the method and parses the values from</tt> </tt>
-<a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"><tt class="py-docstring"> the parameter dictionary.</tt> </tt>
-<a name="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value</tt> </tt>
-<a name="L644"></a><tt class="py-lineno"> 644</tt> <tt class="py-line"><tt class="py-docstring"> comes from the dictionary of methods stored in the 'methods' key in</tt> </tt>
-<a name="L645"></a><tt class="py-lineno"> 645</tt> <tt class="py-line"><tt class="py-docstring"> the deserialized discovery document.</tt> </tt>
-<a name="L646"></a><tt class="py-lineno"> 646</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">arg</tt><tt class="py-op">,</tt> <tt class="py-name">desc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">method_desc</tt><tt class="py-op">.</tt><tt id="link-153" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.discovery_cache.file_cache.Cache.set" class="py-name" href="#" onclick="return doclink('link-157', 'set', 'link-101');">set</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">param_types</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
+<a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">enum_params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
+<a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"> </tt>
+<a name="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-158" class="py-name" targets="Method googleapiclient.discovery.ResourceMethodParameters.set_parameters()=googleapiclient.discovery.ResourceMethodParameters-class.html#set_parameters"><a title="googleapiclient.discovery.ResourceMethodParameters.set_parameters" class="py-name" href="#" onclick="return doclink('link-158', 'set_parameters', 'link-158');">set_parameters</a></tt><tt class="py-op">(</tt><tt class="py-name">method_desc</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"> </tt>
+<a name="ResourceMethodParameters.set_parameters"></a><div id="ResourceMethodParameters.set_parameters-def"><a name="L638"></a><tt class="py-lineno"> 638</tt> <a class="py-toggle" href="#" id="ResourceMethodParameters.set_parameters-toggle" onclick="return toggle('ResourceMethodParameters.set_parameters');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.ResourceMethodParameters-class.html#set_parameters">set_parameters</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">method_desc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="ResourceMethodParameters.set_parameters-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="ResourceMethodParameters.set_parameters-expanded"><a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"> <tt class="py-docstring">"""Populates maps and lists based on method description.</tt> </tt>
+<a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"><tt class="py-docstring"> Iterates through each parameter for the method and parses the values from</tt> </tt>
+<a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"><tt class="py-docstring"> the parameter dictionary.</tt> </tt>
+<a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L644"></a><tt class="py-lineno"> 644</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L645"></a><tt class="py-lineno"> 645</tt> <tt class="py-line"><tt class="py-docstring"> method_desc: Dictionary with metadata describing an API method. Value</tt> </tt>
+<a name="L646"></a><tt class="py-lineno"> 646</tt> <tt class="py-line"><tt class="py-docstring"> comes from the dictionary of methods stored in the 'methods' key in</tt> </tt>
+<a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"><tt class="py-docstring"> the deserialized discovery document.</tt> </tt>
+<a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">arg</tt><tt class="py-op">,</tt> <tt class="py-name">desc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">method_desc</tt><tt class="py-op">.</tt><tt id="link-159" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-153', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'parameters'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"> <tt class="py-name">param</tt> <tt class="py-op">=</tt> <tt id="link-154" class="py-name" targets="Function googleapiclient.discovery.key2param()=googleapiclient.discovery-module.html#key2param"><a title="googleapiclient.discovery.key2param" class="py-name" href="#" onclick="return doclink('link-154', 'key2param', 'link-154');">key2param</a></tt><tt class="py-op">(</tt><tt class="py-name">arg</tt><tt class="py-op">)</tt> </tt>
-<a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">[</tt><tt class="py-name">param</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">arg</tt> </tt>
-<a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"> </tt>
-<a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-155" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-159', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'parameters'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"> <tt class="py-name">param</tt> <tt class="py-op">=</tt> <tt id="link-160" class="py-name" targets="Function googleapiclient.discovery.key2param()=googleapiclient.discovery-module.html#key2param"><a title="googleapiclient.discovery.key2param" class="py-name" href="#" onclick="return doclink('link-160', 'key2param', 'link-160');">key2param</a></tt><tt class="py-op">(</tt><tt class="py-name">arg</tt><tt class="py-op">)</tt> </tt>
+<a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">[</tt><tt class="py-name">param</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">arg</tt> </tt>
+<a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"> </tt>
+<a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-161" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-155', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'pattern'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pattern_params</tt><tt class="py-op">[</tt><tt class="py-name">param</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">desc</tt><tt class="py-op">[</tt><tt class="py-string">'pattern'</tt><tt class="py-op">]</tt> </tt>
-<a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-156" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-161', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'pattern'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L654"></a><tt class="py-lineno"> 654</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pattern_params</tt><tt class="py-op">[</tt><tt class="py-name">param</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">desc</tt><tt class="py-op">[</tt><tt class="py-string">'pattern'</tt><tt class="py-op">]</tt> </tt>
+<a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-162" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-156', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'enum'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L654"></a><tt class="py-lineno"> 654</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">enum_params</tt><tt class="py-op">[</tt><tt class="py-name">param</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">desc</tt><tt class="py-op">[</tt><tt class="py-string">'enum'</tt><tt class="py-op">]</tt> </tt>
-<a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-157" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-162', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'enum'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">enum_params</tt><tt class="py-op">[</tt><tt class="py-name">param</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">desc</tt><tt class="py-op">[</tt><tt class="py-string">'enum'</tt><tt class="py-op">]</tt> </tt>
+<a name="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-163" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-157', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'required'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">required_params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">param</tt><tt class="py-op">)</tt> </tt>
-<a name="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-158" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-163', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'required'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">required_params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">param</tt><tt class="py-op">)</tt> </tt>
+<a name="L659"></a><tt class="py-lineno"> 659</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-164" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-158', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'repeated'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">repeated_params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">param</tt><tt class="py-op">)</tt> </tt>
-<a name="L659"></a><tt class="py-lineno"> 659</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-159" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-164', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'repeated'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">repeated_params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">param</tt><tt class="py-op">)</tt> </tt>
+<a name="L661"></a><tt class="py-lineno"> 661</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-165" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-159', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'location'</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-string">'query'</tt><tt class="py-op">:</tt> </tt>
-<a name="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">query_params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">param</tt><tt class="py-op">)</tt> </tt>
-<a name="L661"></a><tt class="py-lineno"> 661</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-160" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-165', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'location'</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-string">'query'</tt><tt class="py-op">:</tt> </tt>
+<a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">query_params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">param</tt><tt class="py-op">)</tt> </tt>
+<a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-166" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-160', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'location'</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-string">'path'</tt><tt class="py-op">:</tt> </tt>
-<a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">path_params</tt><tt class="py-op">.</tt><tt id="link-161" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest.add()=googleapiclient.http.BatchHttpRequest-class.html#add"><a title="googleapiclient.http.BatchHttpRequest.add" class="py-name" href="#" onclick="return doclink('link-161', 'add', 'link-161');">add</a></tt><tt class="py-op">(</tt><tt class="py-name">param</tt><tt class="py-op">)</tt> </tt>
-<a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">param_types</tt><tt class="py-op">[</tt><tt class="py-name">param</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-162" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-166', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'location'</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-string">'path'</tt><tt class="py-op">:</tt> </tt>
+<a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">path_params</tt><tt class="py-op">.</tt><tt id="link-167" class="py-name" targets="Method googleapiclient.http.BatchHttpRequest.add()=googleapiclient.http.BatchHttpRequest-class.html#add"><a title="googleapiclient.http.BatchHttpRequest.add" class="py-name" href="#" onclick="return doclink('link-167', 'add', 'link-167');">add</a></tt><tt class="py-op">(</tt><tt class="py-name">param</tt><tt class="py-op">)</tt> </tt>
+<a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">param_types</tt><tt class="py-op">[</tt><tt class="py-name">param</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">desc</tt><tt class="py-op">.</tt><tt id="link-168" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-162', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'type'</tt><tt class="py-op">,</tt> <tt class="py-string">'string'</tt><tt class="py-op">)</tt> </tt>
-<a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"> </tt>
-<a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"> <tt class="py-comment"># TODO(dhermes): Determine if this is still necessary. Discovery based APIs</tt> </tt>
-<a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"> <tt class="py-comment"># should have all path parameters already marked with</tt> </tt>
-<a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"> <tt class="py-comment"># 'location: path'.</tt> </tt>
-<a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">match</tt> <tt class="py-keyword">in</tt> <tt id="link-163" class="py-name"><a title="googleapiclient.discovery.URITEMPLATE" class="py-name" href="#" onclick="return doclink('link-163', 'URITEMPLATE', 'link-45');">URITEMPLATE</a></tt><tt class="py-op">.</tt><tt class="py-name">finditer</tt><tt class="py-op">(</tt><tt class="py-name">method_desc</tt><tt class="py-op">[</tt><tt class="py-string">'path'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">namematch</tt> <tt class="py-keyword">in</tt> <tt id="link-164" class="py-name"><a title="googleapiclient.discovery.VARNAME" class="py-name" href="#" onclick="return doclink('link-164', 'VARNAME', 'link-46');">VARNAME</a></tt><tt class="py-op">.</tt><tt class="py-name">finditer</tt><tt class="py-op">(</tt><tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"> <tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt id="link-165" class="py-name"><a title="googleapiclient.discovery.key2param" class="py-name" href="#" onclick="return doclink('link-165', 'key2param', 'link-154');">key2param</a></tt><tt class="py-op">(</tt><tt class="py-name">namematch</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">path_params</tt><tt class="py-op">.</tt><tt id="link-166" class="py-name"><a title="googleapiclient.http.BatchHttpRequest.add" class="py-name" href="#" onclick="return doclink('link-166', 'add', 'link-161');">add</a></tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
-<a name="L672"></a><tt class="py-lineno"> 672</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">query_params</tt><tt class="py-op">:</tt> </tt>
-<a name="L673"></a><tt class="py-lineno"> 673</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">query_params</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
-</div></div><a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"> </tt>
-<a name="createMethod"></a><div id="createMethod-def"><a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"> </tt>
-<a name="L676"></a><tt class="py-lineno"> 676</tt> <a class="py-toggle" href="#" id="createMethod-toggle" onclick="return toggle('createMethod');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#createMethod">createMethod</a><tt class="py-op">(</tt><tt class="py-param">methodName</tt><tt class="py-op">,</tt> <tt class="py-param">methodDesc</tt><tt class="py-op">,</tt> <tt class="py-param">rootDesc</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="createMethod-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="createMethod-expanded"><a name="L677"></a><tt class="py-lineno"> 677</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates a method for attaching to a Resource.</tt> </tt>
-<a name="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"><tt class="py-docstring"> methodName: string, name of the method to use.</tt> </tt>
-<a name="L681"></a><tt class="py-lineno"> 681</tt> <tt class="py-line"><tt class="py-docstring"> methodDesc: object, fragment of deserialized discovery document that</tt> </tt>
-<a name="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"><tt class="py-docstring"> describes the method.</tt> </tt>
-<a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"><tt class="py-docstring"> rootDesc: object, the entire deserialized discovery document.</tt> </tt>
-<a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, mapping of schema names to schema descriptions.</tt> </tt>
-<a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L686"></a><tt class="py-lineno"> 686</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">=</tt> <tt id="link-167" class="py-name" targets="Function googleapiclient.discovery.fix_method_name()=googleapiclient.discovery-module.html#fix_method_name"><a title="googleapiclient.discovery.fix_method_name" class="py-name" href="#" onclick="return doclink('link-167', 'fix_method_name', 'link-167');">fix_method_name</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">)</tt> </tt>
-<a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">pathUrl</tt><tt class="py-op">,</tt> <tt class="py-name">httpMethod</tt><tt class="py-op">,</tt> <tt class="py-name">methodId</tt><tt class="py-op">,</tt> <tt id="link-168" class="py-name"><a title="googleapiclient.model.BaseModel.accept
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-168', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'type'</tt><tt class="py-op">,</tt> <tt class="py-string">'string'</tt><tt class="py-op">)</tt> </tt>
+<a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"> </tt>
+<a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"> <tt class="py-comment"># TODO(dhermes): Determine if this is still necessary. Discovery based APIs</tt> </tt>
+<a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"> <tt class="py-comment"># should have all path parameters already marked with</tt> </tt>
+<a name="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"> <tt class="py-comment"># 'location: path'.</tt> </tt>
+<a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">match</tt> <tt class="py-keyword">in</tt> <tt id="link-169" class="py-name"><a title="googleapiclient.discovery.URITEMPLATE" class="py-name" href="#" onclick="return doclink('link-169', 'URITEMPLATE', 'link-51');">URITEMPLATE</a></tt><tt class="py-op">.</tt><tt class="py-name">finditer</tt><tt class="py-op">(</tt><tt class="py-name">method_desc</tt><tt class="py-op">[</tt><tt class="py-string">'path'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">namematch</tt> <tt class="py-keyword">in</tt> <tt id="link-170" class="py-name"><a title="googleapiclient.discovery.VARNAME" class="py-name" href="#" onclick="return doclink('link-170', 'VARNAME', 'link-52');">VARNAME</a></tt><tt class="py-op">.</tt><tt class="py-name">finditer</tt><tt class="py-op">(</tt><tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L672"></a><tt class="py-lineno"> 672</tt> <tt class="py-line"> <tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt id="link-171" class="py-name"><a title="googleapiclient.discovery.key2param" class="py-name" href="#" onclick="return doclink('link-171', 'key2param', 'link-160');">key2param</a></tt><tt class="py-op">(</tt><tt class="py-name">namematch</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L673"></a><tt class="py-lineno"> 673</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">path_params</tt><tt class="py-op">.</tt><tt id="link-172" class="py-name"><a title="googleapiclient.http.BatchHttpRequest.add" class="py-name" href="#" onclick="return doclink('link-172', 'add', 'link-167');">add</a></tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
+<a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">query_params</tt><tt class="py-op">:</tt> </tt>
+<a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">query_params</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
+</div></div><a name="L676"></a><tt class="py-lineno"> 676</tt> <tt class="py-line"> </tt>
+<a name="createMethod"></a><div id="createMethod-def"><a name="L677"></a><tt class="py-lineno"> 677</tt> <tt class="py-line"> </tt>
+<a name="L678"></a><tt class="py-lineno"> 678</tt> <a class="py-toggle" href="#" id="createMethod-toggle" onclick="return toggle('createMethod');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#createMethod">createMethod</a><tt class="py-op">(</tt><tt class="py-param">methodName</tt><tt class="py-op">,</tt> <tt class="py-param">methodDesc</tt><tt class="py-op">,</tt> <tt class="py-param">rootDesc</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="createMethod-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="createMethod-expanded"><a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates a method for attaching to a Resource.</tt> </tt>
+<a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L681"></a><tt class="py-lineno"> 681</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"><tt class="py-docstring"> methodName: string, name of the method to use.</tt> </tt>
+<a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"><tt class="py-docstring"> methodDesc: object, fragment of deserialized discovery document that</tt> </tt>
+<a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"><tt class="py-docstring"> describes the method.</tt> </tt>
+<a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"><tt class="py-docstring"> rootDesc: object, the entire deserialized discovery document.</tt> </tt>
+<a name="L686"></a><tt class="py-lineno"> 686</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, mapping of schema names to schema descriptions.</tt> </tt>
+<a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">=</tt> <tt id="link-173" class="py-name" targets="Function googleapiclient.discovery.fix_method_name()=googleapiclient.discovery-module.html#fix_method_name"><a title="googleapiclient.discovery.fix_method_name" class="py-name" href="#" onclick="return doclink('link-173', 'fix_method_name', 'link-173');">fix_method_name</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">)</tt> </tt>
+<a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">pathUrl</tt><tt class="py-op">,</tt> <tt class="py-name">httpMethod</tt><tt class="py-op">,</tt> <tt class="py-name">methodId</tt><tt class="py-op">,</tt> <tt id="link-174" class="py-name"><a title="googleapiclient.model.BaseModel.accept
googleapiclient.model.JsonModel.accept
googleapiclient.model.MediaModel.accept
googleapiclient.model.ProtocolBufferModel.accept
-googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-168', 'accept', 'link-136');">accept</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> <tt class="py-name">maxSize</tt><tt class="py-op">,</tt> <tt class="py-name">mediaPathUrl</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt id="link-169" class="py-name" targets="Function googleapiclient.discovery._fix_up_method_description()=googleapiclient.discovery-module.html#_fix_up_method_description"><a title="googleapiclient.discovery._fix_up_method_description" class="py-name" href="#" onclick="return doclink('link-169', '_fix_up_method_description', 'link-169');">_fix_up_method_description</a></tt><tt class="py-op">(</tt><tt class="py-name">methodDesc</tt><tt class="py-op">,</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">)</tt> </tt>
-<a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"> </tt>
-<a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"> <tt class="py-name">parameters</tt> <tt class="py-op">=</tt> <tt id="link-170" class="py-name" targets="Class googleapiclient.discovery.ResourceMethodParameters=googleapiclient.discovery.ResourceMethodParameters-class.html"><a title="googleapiclient.discovery.ResourceMethodParameters" class="py-name" href="#" onclick="return doclink('link-170', 'ResourceMethodParameters', 'link-170');">ResourceMethodParameters</a></tt><tt class="py-op">(</tt><tt class="py-name">methodDesc</tt><tt class="py-op">)</tt> </tt>
+googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-174', 'accept', 'link-142');">accept</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"> <tt class="py-name">maxSize</tt><tt class="py-op">,</tt> <tt class="py-name">mediaPathUrl</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt id="link-175" class="py-name" targets="Function googleapiclient.discovery._fix_up_method_description()=googleapiclient.discovery-module.html#_fix_up_method_description"><a title="googleapiclient.discovery._fix_up_method_description" class="py-name" href="#" onclick="return doclink('link-175', '_fix_up_method_description', 'link-175');">_fix_up_method_description</a></tt><tt class="py-op">(</tt><tt class="py-name">methodDesc</tt><tt class="py-op">,</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">)</tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt> <tt class="py-line"> </tt>
-<a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">method</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"> <tt class="py-comment"># Don't bother with doc string, it will be over-written by createMethod.</tt> </tt>
-<a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"> </tt>
-<a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iterkeys</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">:</tt> </tt>
-<a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'Got an unexpected keyword argument "%s"'</tt> <tt class="py-op">%</tt> <tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
-<a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"> </tt>
-<a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"> <tt class="py-comment"># Remove args that have a value of None.</tt> </tt>
-<a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"> <tt class="py-name">keys</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">keys</tt><tt class="py-op">:</tt> </tt>
-<a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
-<a name="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"> </tt>
-<a name="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">required_params</tt><tt class="py-op">:</tt> </tt>
-<a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">:</tt> </tt>
-<a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'Missing required parameter "%s"'</tt> <tt class="py-op">%</tt> <tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
-<a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"> </tt>
-<a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">regex</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">pattern_params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">:</tt> </tt>
-<a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">string_types</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"> <tt class="py-name">pvalues</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
-<a name="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"> <tt class="py-name">pvalues</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
-<a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">pvalue</tt> <tt class="py-keyword">in</tt> <tt class="py-name">pvalues</tt><tt class="py-op">:</tt> </tt>
-<a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">regex</tt><tt class="py-op">,</tt> <tt class="py-name">pvalue</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt> </tt>
-<a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"> <tt class="py-string">'Parameter "%s" value "%s" does not match the pattern "%s"'</tt> <tt class="py-op">%</tt> </tt>
-<a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">pvalue</tt><tt class="py-op">,</tt> <tt class="py-name">regex</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"> </tt>
-<a name="L721"></a><tt class="py-lineno"> 721</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">enums</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">enum_params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">:</tt> </tt>
-<a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"> <tt class="py-comment"># We need to handle the case of a repeated enum</tt> </tt>
-<a name="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"> <tt class="py-comment"># name differently, since we want to handle both</tt> </tt>
-<a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"> <tt class="py-comment"># arg='value' and arg=['value1', 'value2']</tt> </tt>
-<a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">repeated_params</tt> <tt class="py-keyword">and</tt> </tt>
-<a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">string_types</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"> <tt class="py-name">values</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
-<a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"> <tt class="py-name">values</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
-<a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">values</tt><tt class="py-op">:</tt> </tt>
-<a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enums</tt><tt class="py-op">:</tt> </tt>
-<a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt> </tt>
-<a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"> <tt class="py-string">'Parameter "%s" value "%s" is not an allowed value in "%s"'</tt> <tt class="py-op">%</tt> </tt>
-<a name="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">enums</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"> </tt>
-<a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"> <tt class="py-name">actual_query_params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
-<a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"> <tt class="py-name">actual_path_params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
-<a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"> <tt class="py-name">to_type</tt> <tt class="py-op">=</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">param_types</tt><tt class="py-op">.</tt><tt id="link-171" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+<a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"> <tt class="py-name">parameters</tt> <tt class="py-op">=</tt> <tt id="link-176" class="py-name" targets="Class googleapiclient.discovery.ResourceMethodParameters=googleapiclient.discovery.ResourceMethodParameters-class.html"><a title="googleapiclient.discovery.ResourceMethodParameters" class="py-name" href="#" onclick="return doclink('link-176', 'ResourceMethodParameters', 'link-176');">ResourceMethodParameters</a></tt><tt class="py-op">(</tt><tt class="py-name">methodDesc</tt><tt class="py-op">)</tt> </tt>
+<a name="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"> </tt>
+<a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">method</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"> <tt class="py-comment"># Don't bother with doc string, it will be over-written by createMethod.</tt> </tt>
+<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"> </tt>
+<a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iterkeys</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">:</tt> </tt>
+<a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'Got an unexpected keyword argument "%s"'</tt> <tt class="py-op">%</tt> <tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
+<a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"> </tt>
+<a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"> <tt class="py-comment"># Remove args that have a value of None.</tt> </tt>
+<a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"> <tt class="py-name">keys</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">keys</tt><tt class="py-op">:</tt> </tt>
+<a name="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
+<a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"> </tt>
+<a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">required_params</tt><tt class="py-op">:</tt> </tt>
+<a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">:</tt> </tt>
+<a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'Missing required parameter "%s"'</tt> <tt class="py-op">%</tt> <tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
+<a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"> </tt>
+<a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">regex</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">pattern_params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">:</tt> </tt>
+<a name="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">string_types</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"> <tt class="py-name">pvalues</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
+<a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"> <tt class="py-name">pvalues</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
+<a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">pvalue</tt> <tt class="py-keyword">in</tt> <tt class="py-name">pvalues</tt><tt class="py-op">:</tt> </tt>
+<a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">regex</tt><tt class="py-op">,</tt> <tt class="py-name">pvalue</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt> </tt>
+<a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"> <tt class="py-string">'Parameter "%s" value "%s" does not match the pattern "%s"'</tt> <tt class="py-op">%</tt> </tt>
+<a name="L721"></a><tt class="py-lineno"> 721</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">pvalue</tt><tt class="py-op">,</tt> <tt class="py-name">regex</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"> </tt>
+<a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">enums</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">enum_params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">:</tt> </tt>
+<a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"> <tt class="py-comment"># We need to handle the case of a repeated enum</tt> </tt>
+<a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"> <tt class="py-comment"># name differently, since we want to handle both</tt> </tt>
+<a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"> <tt class="py-comment"># arg='value' and arg=['value1', 'value2']</tt> </tt>
+<a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">repeated_params</tt> <tt class="py-keyword">and</tt> </tt>
+<a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">string_types</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"> <tt class="py-name">values</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
+<a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"> <tt class="py-name">values</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
+<a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">values</tt><tt class="py-op">:</tt> </tt>
+<a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enums</tt><tt class="py-op">:</tt> </tt>
+<a name="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt> </tt>
+<a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"> <tt class="py-string">'Parameter "%s" value "%s" is not an allowed value in "%s"'</tt> <tt class="py-op">%</tt> </tt>
+<a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">enums</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"> </tt>
+<a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"> <tt class="py-name">actual_query_params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
+<a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"> <tt class="py-name">actual_path_params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
+<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"> <tt class="py-name">to_type</tt> <tt class="py-op">=</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">param_types</tt><tt class="py-op">.</tt><tt id="link-177" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-171', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-string">'string'</tt><tt class="py-op">)</tt> </tt>
-<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"> <tt class="py-comment"># For repeated parameters we cast each member of the list.</tt> </tt>
-<a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">key</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">repeated_params</tt> <tt class="py-keyword">and</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"> <tt class="py-name">cast_value</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-172" class="py-name" targets="Function googleapiclient.discovery._cast()=googleapiclient.discovery-module.html#_cast"><a title="googleapiclient.discovery._cast" class="py-name" href="#" onclick="return doclink('link-172', '_cast', 'link-172');">_cast</a></tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">,</tt> <tt class="py-name">to_type</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">x</tt> <tt class="py-keyword">in</tt> <tt class="py-name">value</tt><tt class="py-op">]</tt> </tt>
-<a name="L744"></a><tt class="py-lineno"> 744</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"> <tt class="py-name">cast_value</tt> <tt class="py-op">=</tt> <tt id="link-173" class="py-name"><a title="googleapiclient.discovery._cast" class="py-name" href="#" onclick="return doclink('link-173', '_cast', 'link-172');">_cast</a></tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt class="py-name">to_type</tt><tt class="py-op">)</tt> </tt>
-<a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">key</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">query_params</tt><tt class="py-op">:</tt> </tt>
-<a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"> <tt class="py-name">actual_query_params</tt><tt class="py-op">[</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">cast_value</tt> </tt>
-<a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">key</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">path_params</tt><tt class="py-op">:</tt> </tt>
-<a name="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"> <tt class="py-name">actual_path_params</tt><tt class="py-op">[</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">cast_value</tt> </tt>
-<a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"> <tt class="py-name">body_value</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt id="link-174" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-177', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-string">'string'</tt><tt class="py-op">)</tt> </tt>
+<a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"> <tt class="py-comment"># For repeated parameters we cast each member of the list.</tt> </tt>
+<a name="L744"></a><tt class="py-lineno"> 744</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">key</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">repeated_params</tt> <tt class="py-keyword">and</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"> <tt class="py-name">cast_value</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-178" class="py-name" targets="Function googleapiclient.discovery._cast()=googleapiclient.discovery-module.html#_cast"><a title="googleapiclient.discovery._cast" class="py-name" href="#" onclick="return doclink('link-178', '_cast', 'link-178');">_cast</a></tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">,</tt> <tt class="py-name">to_type</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">x</tt> <tt class="py-keyword">in</tt> <tt class="py-name">value</tt><tt class="py-op">]</tt> </tt>
+<a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"> <tt class="py-name">cast_value</tt> <tt class="py-op">=</tt> <tt id="link-179" class="py-name"><a title="googleapiclient.discovery._cast" class="py-name" href="#" onclick="return doclink('link-179', '_cast', 'link-178');">_cast</a></tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt class="py-name">to_type</tt><tt class="py-op">)</tt> </tt>
+<a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">key</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">query_params</tt><tt class="py-op">:</tt> </tt>
+<a name="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"> <tt class="py-name">actual_query_params</tt><tt class="py-op">[</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">cast_value</tt> </tt>
+<a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">key</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">path_params</tt><tt class="py-op">:</tt> </tt>
+<a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"> <tt class="py-name">actual_path_params</tt><tt class="py-op">[</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">cast_value</tt> </tt>
+<a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"> <tt class="py-name">body_value</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt id="link-180" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-174', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'body'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
-<a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"> <tt class="py-name">media_filename</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt id="link-175" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-180', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'body'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
+<a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"> <tt class="py-name">media_filename</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt id="link-181" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-175', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'media_body'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
-<a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"> </tt>
-<a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_developerKey</tt><tt class="py-op">:</tt> </tt>
-<a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"> <tt class="py-name">actual_query_params</tt><tt class="py-op">[</tt><tt class="py-string">'key'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_developerKey</tt> </tt>
-<a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"> </tt>
-<a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"> <tt id="link-176" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-176', 'model', 'link-33');">model</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt> </tt>
-<a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">methodName</tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'_media'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"> <tt id="link-177" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-177', 'model', 'link-33');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-178" class="py-name"><a title="googleapiclient.model.MediaModel" class="py-name" href="#" onclick="return doclink('link-178', 'MediaModel', 'link-37');">MediaModel</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-string">'response'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">:</tt> </tt>
-<a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"> <tt id="link-179" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-179', 'model', 'link-33');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-180" class="py-name"><a title="googleapiclient.model.RawModel" class="py-name" href="#" onclick="return doclink('link-180', 'RawModel', 'link-40');">RawModel</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L761"></a><tt class="py-lineno"> 761</tt> <tt class="py-line"> </tt>
-<a name="L762"></a><tt class="py-lineno"> 762</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
-<a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">,</tt> <tt class="py-name">query</tt><tt class="py-op">,</tt> <tt id="link-181" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-181', 'body', 'link-130');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-182" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-182', 'model', 'link-33');">model</a></tt><tt class="py-op">.</tt><tt id="link-183" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-181', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'media_body'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
+<a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"> </tt>
+<a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_developerKey</tt><tt class="py-op">:</tt> </tt>
+<a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"> <tt class="py-name">actual_query_params</tt><tt class="py-op">[</tt><tt class="py-string">'key'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_developerKey</tt> </tt>
+<a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"> </tt>
+<a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"> <tt id="link-182" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-182', 'model', 'link-39');">model</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt> </tt>
+<a name="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">methodName</tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'_media'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"> <tt id="link-183" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-183', 'model', 'link-39');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-184" class="py-name"><a title="googleapiclient.model.MediaModel" class="py-name" href="#" onclick="return doclink('link-184', 'MediaModel', 'link-43');">MediaModel</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L761"></a><tt class="py-lineno"> 761</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-string">'response'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">:</tt> </tt>
+<a name="L762"></a><tt class="py-lineno"> 762</tt> <tt class="py-line"> <tt id="link-185" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-185', 'model', 'link-39');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-186" class="py-name"><a title="googleapiclient.model.RawModel" class="py-name" href="#" onclick="return doclink('link-186', 'RawModel', 'link-46');">RawModel</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"> </tt>
+<a name="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
+<a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">,</tt> <tt class="py-name">query</tt><tt class="py-op">,</tt> <tt id="link-187" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-187', 'body', 'link-136');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-188" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-188', 'model', 'link-39');">model</a></tt><tt class="py-op">.</tt><tt id="link-189" class="py-name"><a title="googleapiclient.http.HttpMock.request
googleapiclient.http.HttpMockSequence.request
googleapiclient.model.BaseModel.request
-googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-183', 'request', 'link-89');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">headers</tt><tt class="py-op">,</tt> </tt>
-<a name="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"> <tt class="py-name">actual_path_params</tt><tt class="py-op">,</tt> <tt class="py-name">actual_query_params</tt><tt class="py-op">,</tt> <tt class="py-name">body_value</tt><tt class="py-op">)</tt> </tt>
-<a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"> </tt>
-<a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"> <tt class="py-name">expanded_url</tt> <tt class="py-op">=</tt> <tt class="py-name">uritemplate</tt><tt class="py-op">.</tt><tt class="py-name">expand</tt><tt class="py-op">(</tt><tt class="py-name">pathUrl</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
-<a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt id="link-184" class="py-name" targets="Function googleapiclient.discovery._urljoin()=googleapiclient.discovery-module.html#_urljoin"><a title="googleapiclient.discovery._urljoin" class="py-name" href="#" onclick="return doclink('link-184', '_urljoin', 'link-184');">_urljoin</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_baseUrl</tt><tt class="py-op">,</tt> <tt class="py-name">expanded_url</tt> <tt class="py-op">+</tt> <tt class="py-name">query</tt><tt class="py-op">)</tt> </tt>
-<a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"> </tt>
-<a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"> <tt id="link-185" class="py-name" targets="Method googleapiclient.http.MediaIoBaseUpload.resumable()=googleapiclient.http.MediaIoBaseUpload-class.html#resumable,Method googleapiclient.http.MediaUpload.resumable()=googleapiclient.http.MediaUpload-class.html#resumable"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
-googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-185', 'resumable', 'link-185');">resumable</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
-<a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"> <tt class="py-name">multipart_boundary</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
-<a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"> </tt>
-<a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">media_filename</tt><tt class="py-op">:</tt> </tt>
-<a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"> <tt class="py-comment"># Ensure we end up with a valid MediaUpload object.</tt> </tt>
-<a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">media_filename</tt><tt class="py-op">,</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">string_types</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">media_mime_type</tt><tt class="py-op">,</tt> <tt class="py-name">encoding</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">mimetypes</tt><tt class="py-op">.</tt><tt class="py-name">guess_type</tt><tt class="py-op">(</tt><tt class="py-name">media_filename</tt><tt class="py-op">)</tt> </tt>
-<a name="L776"></a><tt class="py-lineno"> 776</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">media_mime_type</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-186" class="py-name"><a title="googleapiclient.errors.UnknownFileType" class="py-name" href="#" onclick="return doclink('link-186', 'UnknownFileType', 'link-19');">UnknownFileType</a></tt><tt class="py-op">(</tt><tt class="py-name">media_filename</tt><tt class="py-op">)</tt> </tt>
-<a name="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-187" class="py-name"><a title="googleapiclient.mimeparse" class="py-name" href="#" onclick="return doclink('link-187', 'mimeparse', 'link-1');">mimeparse</a></tt><tt class="py-op">.</tt><tt id="link-188" class="py-name" targets="Function googleapiclient.mimeparse.best_match()=googleapiclient.mimeparse-module.html#best_match"><a title="googleapiclient.mimeparse.best_match" class="py-name" href="#" onclick="return doclink('link-188', 'best_match', 'link-188');">best_match</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">media_mime_type</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">','</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt id="link-189" class="py-name"><a title="googleapiclient.model.BaseModel.accept
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-189', 'request', 'link-95');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">headers</tt><tt class="py-op">,</tt> </tt>
+<a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"> <tt class="py-name">actual_path_params</tt><tt class="py-op">,</tt> <tt class="py-name">actual_query_params</tt><tt class="py-op">,</tt> <tt class="py-name">body_value</tt><tt class="py-op">)</tt> </tt>
+<a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"> </tt>
+<a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"> <tt class="py-name">expanded_url</tt> <tt class="py-op">=</tt> <tt class="py-name">uritemplate</tt><tt class="py-op">.</tt><tt class="py-name">expand</tt><tt class="py-op">(</tt><tt class="py-name">pathUrl</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
+<a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt id="link-190" class="py-name" targets="Function googleapiclient.discovery._urljoin()=googleapiclient.discovery-module.html#_urljoin"><a title="googleapiclient.discovery._urljoin" class="py-name" href="#" onclick="return doclink('link-190', '_urljoin', 'link-190');">_urljoin</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_baseUrl</tt><tt class="py-op">,</tt> <tt class="py-name">expanded_url</tt> <tt class="py-op">+</tt> <tt class="py-name">query</tt><tt class="py-op">)</tt> </tt>
+<a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"> </tt>
+<a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"> <tt id="link-191" class="py-name" targets="Method googleapiclient.http.MediaIoBaseUpload.resumable()=googleapiclient.http.MediaIoBaseUpload-class.html#resumable,Method googleapiclient.http.MediaUpload.resumable()=googleapiclient.http.MediaUpload-class.html#resumable"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
+googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-191', 'resumable', 'link-191');">resumable</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
+<a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"> <tt class="py-name">multipart_boundary</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
+<a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"> </tt>
+<a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">media_filename</tt><tt class="py-op">:</tt> </tt>
+<a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"> <tt class="py-comment"># Ensure we end up with a valid MediaUpload object.</tt> </tt>
+<a name="L776"></a><tt class="py-lineno"> 776</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">media_filename</tt><tt class="py-op">,</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">string_types</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">media_mime_type</tt><tt class="py-op">,</tt> <tt class="py-name">encoding</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">mimetypes</tt><tt class="py-op">.</tt><tt class="py-name">guess_type</tt><tt class="py-op">(</tt><tt class="py-name">media_filename</tt><tt class="py-op">)</tt> </tt>
+<a name="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">media_mime_type</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-192" class="py-name"><a title="googleapiclient.errors.UnknownFileType" class="py-name" href="#" onclick="return doclink('link-192', 'UnknownFileType', 'link-19');">UnknownFileType</a></tt><tt class="py-op">(</tt><tt class="py-name">media_filename</tt><tt class="py-op">)</tt> </tt>
+<a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-193" class="py-name"><a title="googleapiclient.mimeparse" class="py-name" href="#" onclick="return doclink('link-193', 'mimeparse', 'link-1');">mimeparse</a></tt><tt class="py-op">.</tt><tt id="link-194" class="py-name" targets="Function googleapiclient.mimeparse.best_match()=googleapiclient.mimeparse-module.html#best_match"><a title="googleapiclient.mimeparse.best_match" class="py-name" href="#" onclick="return doclink('link-194', 'best_match', 'link-194');">best_match</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">media_mime_type</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">','</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt id="link-195" class="py-name"><a title="googleapiclient.model.BaseModel.accept
googleapiclient.model.JsonModel.accept
googleapiclient.model.MediaModel.accept
googleapiclient.model.ProtocolBufferModel.accept
-googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-189', 'accept', 'link-136');">accept</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-190" class="py-name"><a title="googleapiclient.errors.UnacceptableMimeTypeError" class="py-name" href="#" onclick="return doclink('link-190', 'UnacceptableMimeTypeError', 'link-13');">UnacceptableMimeTypeError</a></tt><tt class="py-op">(</tt><tt class="py-name">media_mime_type</tt><tt class="py-op">)</tt> </tt>
-<a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"> <tt class="py-name">media_upload</tt> <tt class="py-op">=</tt> <tt id="link-191" class="py-name"><a title="googleapiclient.http.MediaFileUpload" class="py-name" href="#" onclick="return doclink('link-191', 'MediaFileUpload', 'link-28');">MediaFileUpload</a></tt><tt class="py-op">(</tt><tt class="py-name">media_filename</tt><tt class="py-op">,</tt> </tt>
-<a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"> <tt id="link-192" class="py-name" targets="Method googleapiclient.http.MediaIoBaseUpload.mimetype()=googleapiclient.http.MediaIoBaseUpload-class.html#mimetype,Method googleapiclient.http.MediaUpload.mimetype()=googleapiclient.http.MediaUpload-class.html#mimetype"><a title="googleapiclient.http.MediaIoBaseUpload.mimetype
-googleapiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-192', 'mimetype', 'link-192');">mimetype</a></tt><tt class="py-op">=</tt><tt class="py-name">media_mime_type</tt><tt class="py-op">)</tt> </tt>
-<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">media_filename</tt><tt class="py-op">,</tt> <tt id="link-193" class="py-name"><a title="googleapiclient.http.MediaUpload" class="py-name" href="#" onclick="return doclink('link-193', 'MediaUpload', 'link-31');">MediaUpload</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"> <tt class="py-name">media_upload</tt> <tt class="py-op">=</tt> <tt class="py-name">media_filename</tt> </tt>
-<a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'media_filename must be str or MediaUpload.'</tt><tt class="py-op">)</tt> </tt>
-<a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"> </tt>
-<a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"> <tt class="py-comment"># Check the maxSize</tt> </tt>
-<a name="L788"></a><tt class="py-lineno"> 788</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-194" class="py-name" targets="Method googleapiclient.http.MediaIoBaseUpload.size()=googleapiclient.http.MediaIoBaseUpload-class.html#size,Method googleapiclient.http.MediaUpload.size()=googleapiclient.http.MediaUpload-class.html#size"><a title="googleapiclient.http.MediaIoBaseUpload.size
-googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-194', 'size', 'link-194');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-195" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.size
-googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-195', 'size', 'link-194');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-name">maxSize</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
-<a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-196" class="py-name"><a title="googleapiclient.errors.MediaUploadSizeError" class="py-name" href="#" onclick="return doclink('link-196', 'MediaUploadSizeError', 'link-10');">MediaUploadSizeError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Media larger than: %s"</tt> <tt class="py-op">%</tt> <tt class="py-name">maxSize</tt><tt class="py-op">)</tt> </tt>
-<a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"> </tt>
-<a name="L791"></a><tt class="py-lineno"> 791</tt> <tt class="py-line"> <tt class="py-comment"># Use the media path uri for media uploads</tt> </tt>
-<a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"> <tt class="py-name">expanded_url</tt> <tt class="py-op">=</tt> <tt class="py-name">uritemplate</tt><tt class="py-op">.</tt><tt class="py-name">expand</tt><tt class="py-op">(</tt><tt class="py-name">mediaPathUrl</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
-<a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt id="link-197" class="py-name"><a title="googleapiclient.discovery._urljoin" class="py-name" href="#" onclick="return doclink('link-197', '_urljoin', 'link-184');">_urljoin</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_baseUrl</tt><tt class="py-op">,</tt> <tt class="py-name">expanded_url</tt> <tt class="py-op">+</tt> <tt class="py-name">query</tt><tt class="py-op">)</tt> </tt>
-<a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-198" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
-googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-198', 'resumable', 'link-185');">resumable</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt class="py-name">_add_query_parameter</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-string">'uploadType'</tt><tt class="py-op">,</tt> <tt class="py-string">'resumable'</tt><tt class="py-op">)</tt> </tt>
-<a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"> </tt>
-<a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-199" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
-googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-199', 'resumable', 'link-185');">resumable</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"> <tt class="py-comment"># This is all we need to do for resumable, if the body exists it gets</tt> </tt>
-<a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"> <tt class="py-comment"># sent in the first request, otherwise an empty body is sent.</tt> </tt>
-<a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"> <tt id="link-200" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
-googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-200', 'resumable', 'link-185');">resumable</a></tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt> </tt>
-<a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"> <tt class="py-comment"># A non-resumable upload</tt> </tt>
-<a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-201" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-201', 'body', 'link-130');">body</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
-<a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"> <tt class="py-comment"># This is a simple media upload</tt> </tt>
-<a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'content-type'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-202" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.mimetype
-googleapiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-202', 'mimetype', 'link-192');">mimetype</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"> <tt id="link-203" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-203', 'body', 'link-130');">body</a></tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-204" class="py-name" targets="Method googleapiclient.http.MediaIoBaseUpload.getbytes()=googleapiclient.http.MediaIoBaseUpload-class.html#getbytes,Method googleapiclient.http.MediaUpload.getbytes()=googleapiclient.http.MediaUpload-class.html#getbytes"><a title="googleapiclient.http.MediaIoBaseUpload.getbytes
-googleapiclient.http.MediaUpload.getbytes" class="py-name" href="#" onclick="return doclink('link-204', 'getbytes', 'link-204');">getbytes</a></tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-205" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.size
-googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-205', 'size', 'link-194');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt class="py-name">_add_query_parameter</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-string">'uploadType'</tt><tt class="py-op">,</tt> <tt class="py-string">'media'</tt><tt class="py-op">)</tt> </tt>
-<a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"> <tt class="py-comment"># This is a multipart/related upload.</tt> </tt>
-<a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"> <tt class="py-name">msgRoot</tt> <tt class="py-op">=</tt> <tt class="py-name">MIMEMultipart</tt><tt class="py-op">(</tt><tt class="py-string">'related'</tt><tt class="py-op">)</tt> </tt>
-<a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"> <tt class="py-comment"># msgRoot should not write out it's own headers</tt> </tt>
-<a name="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">msgRoot</tt><tt class="py-op">,</tt> <tt class="py-string">'_write_headers'</tt><tt class="py-op">,</tt> <tt class="py-keyword">lambda</tt> <tt class="py-name">self</tt><tt class="py-op">:</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
-<a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"> </tt>
-<a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"> <tt class="py-comment"># attach the body as one part</tt> </tt>
-<a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-name">MIMENonMultipart</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'content-type'</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L816"></a><tt class="py-lineno"> 816</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">.</tt><tt class="py-name">set_payload</tt><tt class="py-op">(</tt><tt id="link-206" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-206', 'body', 'link-130');">body</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"> <tt class="py-name">msgRoot</tt><tt class="py-op">.</tt><tt class="py-name">attach</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
-<a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"> </tt>
-<a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"> <tt class="py-comment"># attach the media as the second part</tt> </tt>
-<a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-name">MIMENonMultipart</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-207" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.mimetype
-googleapiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-207', 'mimetype', 'link-192');">mimetype</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">[</tt><tt class="py-string">'Content-Transfer-Encoding'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">'binary'</tt> </tt>
-<a name="L822"></a><tt class="py-lineno"> 822</tt> <tt class="py-line"> </tt>
-<a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"> <tt class="py-name">payload</tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-208" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.getbytes
-googleapiclient.http.MediaUpload.getbytes" class="py-name" href="#" onclick="return doclink('link-208', 'getbytes', 'link-204');">getbytes</a></tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-209" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.size
-googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-209', 'size', 'link-194');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">.</tt><tt class="py-name">set_payload</tt><tt class="py-op">(</tt><tt class="py-name">payload</tt><tt class="py-op">)</tt> </tt>
-<a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"> <tt class="py-name">msgRoot</tt><tt class="py-op">.</tt><tt class="py-name">attach</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
-<a name="L826"></a><tt class="py-lineno"> 826</tt> <tt class="py-line"> <tt class="py-comment"># encode the body: note that we can't use `as_string`, because</tt> </tt>
-<a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"> <tt class="py-comment"># it plays games with `From ` lines.</tt> </tt>
-<a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"> <tt class="py-name">fp</tt> <tt class="py-op">=</tt> <tt class="py-name">BytesIO</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"> <tt class="py-name">g</tt> <tt class="py-op">=</tt> <tt id="link-210" class="py-name" targets="Class googleapiclient.discovery._BytesGenerator=googleapiclient.discovery._BytesGenerator-class.html"><a title="googleapiclient.discovery._BytesGenerator" class="py-name" href="#" onclick="return doclink('link-210', '_BytesGenerator', 'link-210');">_BytesGenerator</a></tt><tt class="py-op">(</tt><tt class="py-name">fp</tt><tt class="py-op">,</tt> <tt class="py-name">mangle_from_</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
-<a name="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"> <tt class="py-name">g</tt><tt class="py-op">.</tt><tt class="py-name">flatten</tt><tt class="py-op">(</tt><tt class="py-name">msgRoot</tt><tt class="py-op">,</tt> <tt class="py-name">unixfrom</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
-<a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"> <tt id="link-211" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-211', 'body', 'link-130');">body</a></tt> <tt class="py-op">=</tt> <tt class="py-name">fp</tt><tt class="py-op">.</tt><tt class="py-name">getvalue</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"> </tt>
-<a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"> <tt class="py-name">multipart_boundary</tt> <tt class="py-op">=</tt> <tt class="py-name">msgRoot</tt><tt class="py-op">.</tt><tt class="py-name">get_boundary</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'content-type'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'multipart/related; '</tt> </tt>
-<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"> <tt class="py-string">'boundary="%s"'</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> <tt class="py-name">multipart_boundary</tt> </tt>
-<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt class="py-name">_add_query_parameter</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-string">'uploadType'</tt><tt class="py-op">,</tt> <tt class="py-string">'multipart'</tt><tt class="py-op">)</tt> </tt>
-<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"> </tt>
-<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"> <tt id="link-212" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-212', 'logger', 'link-44');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'URL being requested: %s %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">httpMethod</tt><tt class="py-op">,</tt><tt class="py-name">url</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requestBuilder</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_http</tt><tt class="py-op">,</tt> </tt>
-<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"> <tt id="link-213" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-213', 'model', 'link-33');">model</a></tt><tt class="py-op">.</tt><tt id="link-214" class="py-name" targets="Method googleapiclient.model.BaseModel.response()=googleapiclient.model.BaseModel-class.html#response,Method googleapiclient.model.Model.response()=googleapiclient.model.Model-class.html#response"><a title="googleapiclient.model.BaseModel.response
-googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-214', 'response', 'link-214');">response</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"> <tt class="py-name">url</tt><tt class="py-op">,</tt> </tt>
-<a name="L842"></a><tt class="py-lineno"> 842</tt> <tt class="py-line"> <tt class="py-name">method</tt><tt class="py-op">=</tt><tt class="py-name">httpMethod</tt><tt class="py-op">,</tt> </tt>
-<a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"> <tt id="link-215" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-215', 'body', 'link-130');">body</a></tt><tt class="py-op">=</tt><tt id="link-216" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-216', 'body', 'link-130');">body</a></tt><tt class="py-op">,</tt> </tt>
-<a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">=</tt><tt class="py-name">headers</tt><tt class="py-op">,</tt> </tt>
-<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"> <tt class="py-name">methodId</tt><tt class="py-op">=</tt><tt class="py-name">methodId</tt><tt class="py-op">,</tt> </tt>
-<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"> <tt id="link-217" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
-googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-217', 'resumable', 'link-185');">resumable</a></tt><tt class="py-op">=</tt><tt id="link-218" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
-googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-218', 'resumable', 'link-185');">resumable</a></tt><tt class="py-op">)</tt> </tt>
-</div><a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"> </tt>
-<a name="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">methodDesc</tt><tt class="py-op">.</tt><tt id="link-219" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.model.RawModel.accept" class="py-name" href="#" onclick="return doclink('link-195', 'accept', 'link-142');">accept</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-196" class="py-name"><a title="googleapiclient.errors.UnacceptableMimeTypeError" class="py-name" href="#" onclick="return doclink('link-196', 'UnacceptableMimeTypeError', 'link-13');">UnacceptableMimeTypeError</a></tt><tt class="py-op">(</tt><tt class="py-name">media_mime_type</tt><tt class="py-op">)</tt> </tt>
+<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"> <tt class="py-name">media_upload</tt> <tt class="py-op">=</tt> <tt id="link-197" class="py-name"><a title="googleapiclient.http.MediaFileUpload" class="py-name" href="#" onclick="return doclink('link-197', 'MediaFileUpload', 'link-34');">MediaFileUpload</a></tt><tt class="py-op">(</tt><tt class="py-name">media_filename</tt><tt class="py-op">,</tt> </tt>
+<a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"> <tt id="link-198" class="py-name" targets="Method googleapiclient.http.MediaIoBaseUpload.mimetype()=googleapiclient.http.MediaIoBaseUpload-class.html#mimetype,Method googleapiclient.http.MediaUpload.mimetype()=googleapiclient.http.MediaUpload-class.html#mimetype"><a title="googleapiclient.http.MediaIoBaseUpload.mimetype
+googleapiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-198', 'mimetype', 'link-198');">mimetype</a></tt><tt class="py-op">=</tt><tt class="py-name">media_mime_type</tt><tt class="py-op">)</tt> </tt>
+<a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">media_filename</tt><tt class="py-op">,</tt> <tt id="link-199" class="py-name"><a title="googleapiclient.http.MediaUpload" class="py-name" href="#" onclick="return doclink('link-199', 'MediaUpload', 'link-37');">MediaUpload</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"> <tt class="py-name">media_upload</tt> <tt class="py-op">=</tt> <tt class="py-name">media_filename</tt> </tt>
+<a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'media_filename must be str or MediaUpload.'</tt><tt class="py-op">)</tt> </tt>
+<a name="L788"></a><tt class="py-lineno"> 788</tt> <tt class="py-line"> </tt>
+<a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"> <tt class="py-comment"># Check the maxSize</tt> </tt>
+<a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-200" class="py-name" targets="Method googleapiclient.http.MediaIoBaseUpload.size()=googleapiclient.http.MediaIoBaseUpload-class.html#size,Method googleapiclient.http.MediaUpload.size()=googleapiclient.http.MediaUpload-class.html#size"><a title="googleapiclient.http.MediaIoBaseUpload.size
+googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-200', 'size', 'link-200');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-201" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.size
+googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-201', 'size', 'link-200');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-name">maxSize</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
+<a name="L791"></a><tt class="py-lineno"> 791</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-202" class="py-name"><a title="googleapiclient.errors.MediaUploadSizeError" class="py-name" href="#" onclick="return doclink('link-202', 'MediaUploadSizeError', 'link-10');">MediaUploadSizeError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Media larger than: %s"</tt> <tt class="py-op">%</tt> <tt class="py-name">maxSize</tt><tt class="py-op">)</tt> </tt>
+<a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"> </tt>
+<a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"> <tt class="py-comment"># Use the media path uri for media uploads</tt> </tt>
+<a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"> <tt class="py-name">expanded_url</tt> <tt class="py-op">=</tt> <tt class="py-name">uritemplate</tt><tt class="py-op">.</tt><tt class="py-name">expand</tt><tt class="py-op">(</tt><tt class="py-name">mediaPathUrl</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">)</tt> </tt>
+<a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt id="link-203" class="py-name"><a title="googleapiclient.discovery._urljoin" class="py-name" href="#" onclick="return doclink('link-203', '_urljoin', 'link-190');">_urljoin</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_baseUrl</tt><tt class="py-op">,</tt> <tt class="py-name">expanded_url</tt> <tt class="py-op">+</tt> <tt class="py-name">query</tt><tt class="py-op">)</tt> </tt>
+<a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-204" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
+googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-204', 'resumable', 'link-191');">resumable</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt class="py-name">_add_query_parameter</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-string">'uploadType'</tt><tt class="py-op">,</tt> <tt class="py-string">'resumable'</tt><tt class="py-op">)</tt> </tt>
+<a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"> </tt>
+<a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-205" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
+googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-205', 'resumable', 'link-191');">resumable</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"> <tt class="py-comment"># This is all we need to do for resumable, if the body exists it gets</tt> </tt>
+<a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"> <tt class="py-comment"># sent in the first request, otherwise an empty body is sent.</tt> </tt>
+<a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"> <tt id="link-206" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
+googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-206', 'resumable', 'link-191');">resumable</a></tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt> </tt>
+<a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"> <tt class="py-comment"># A non-resumable upload</tt> </tt>
+<a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-207" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-207', 'body', 'link-136');">body</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"> <tt class="py-comment"># This is a simple media upload</tt> </tt>
+<a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'content-type'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-208" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.mimetype
+googleapiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-208', 'mimetype', 'link-198');">mimetype</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"> <tt id="link-209" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-209', 'body', 'link-136');">body</a></tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-210" class="py-name" targets="Method googleapiclient.http.MediaIoBaseUpload.getbytes()=googleapiclient.http.MediaIoBaseUpload-class.html#getbytes,Method googleapiclient.http.MediaUpload.getbytes()=googleapiclient.http.MediaUpload-class.html#getbytes"><a title="googleapiclient.http.MediaIoBaseUpload.getbytes
+googleapiclient.http.MediaUpload.getbytes" class="py-name" href="#" onclick="return doclink('link-210', 'getbytes', 'link-210');">getbytes</a></tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-211" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.size
+googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-211', 'size', 'link-200');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt class="py-name">_add_query_parameter</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-string">'uploadType'</tt><tt class="py-op">,</tt> <tt class="py-string">'media'</tt><tt class="py-op">)</tt> </tt>
+<a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"> <tt class="py-comment"># This is a multipart/related upload.</tt> </tt>
+<a name="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"> <tt class="py-name">msgRoot</tt> <tt class="py-op">=</tt> <tt class="py-name">MIMEMultipart</tt><tt class="py-op">(</tt><tt class="py-string">'related'</tt><tt class="py-op">)</tt> </tt>
+<a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"> <tt class="py-comment"># msgRoot should not write out it's own headers</tt> </tt>
+<a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">msgRoot</tt><tt class="py-op">,</tt> <tt class="py-string">'_write_headers'</tt><tt class="py-op">,</tt> <tt class="py-keyword">lambda</tt> <tt class="py-name">self</tt><tt class="py-op">:</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
+<a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"> </tt>
+<a name="L816"></a><tt class="py-lineno"> 816</tt> <tt class="py-line"> <tt class="py-comment"># attach the body as one part</tt> </tt>
+<a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-name">MIMENonMultipart</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'content-type'</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">.</tt><tt class="py-name">set_payload</tt><tt class="py-op">(</tt><tt id="link-212" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-212', 'body', 'link-136');">body</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"> <tt class="py-name">msgRoot</tt><tt class="py-op">.</tt><tt class="py-name">attach</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
+<a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"> </tt>
+<a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"> <tt class="py-comment"># attach the media as the second part</tt> </tt>
+<a name="L822"></a><tt class="py-lineno"> 822</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-name">MIMENonMultipart</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-213" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.mimetype
+googleapiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-213', 'mimetype', 'link-198');">mimetype</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">[</tt><tt class="py-string">'Content-Transfer-Encoding'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">'binary'</tt> </tt>
+<a name="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"> </tt>
+<a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"> <tt class="py-name">payload</tt> <tt class="py-op">=</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-214" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.getbytes
+googleapiclient.http.MediaUpload.getbytes" class="py-name" href="#" onclick="return doclink('link-214', 'getbytes', 'link-210');">getbytes</a></tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-name">media_upload</tt><tt class="py-op">.</tt><tt id="link-215" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.size
+googleapiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-215', 'size', 'link-200');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L826"></a><tt class="py-lineno"> 826</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">.</tt><tt class="py-name">set_payload</tt><tt class="py-op">(</tt><tt class="py-name">payload</tt><tt class="py-op">)</tt> </tt>
+<a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"> <tt class="py-name">msgRoot</tt><tt class="py-op">.</tt><tt class="py-name">attach</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
+<a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"> <tt class="py-comment"># encode the body: note that we can't use `as_string`, because</tt> </tt>
+<a name="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"> <tt class="py-comment"># it plays games with `From ` lines.</tt> </tt>
+<a name="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"> <tt class="py-name">fp</tt> <tt class="py-op">=</tt> <tt class="py-name">BytesIO</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"> <tt class="py-name">g</tt> <tt class="py-op">=</tt> <tt id="link-216" class="py-name" targets="Class googleapiclient.discovery._BytesGenerator=googleapiclient.discovery._BytesGenerator-class.html"><a title="googleapiclient.discovery._BytesGenerator" class="py-name" href="#" onclick="return doclink('link-216', '_BytesGenerator', 'link-216');">_BytesGenerator</a></tt><tt class="py-op">(</tt><tt class="py-name">fp</tt><tt class="py-op">,</tt> <tt class="py-name">mangle_from_</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
+<a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"> <tt class="py-name">g</tt><tt class="py-op">.</tt><tt class="py-name">flatten</tt><tt class="py-op">(</tt><tt class="py-name">msgRoot</tt><tt class="py-op">,</tt> <tt class="py-name">unixfrom</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
+<a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"> <tt id="link-217" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-217', 'body', 'link-136');">body</a></tt> <tt class="py-op">=</tt> <tt class="py-name">fp</tt><tt class="py-op">.</tt><tt class="py-name">getvalue</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"> </tt>
+<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"> <tt class="py-name">multipart_boundary</tt> <tt class="py-op">=</tt> <tt class="py-name">msgRoot</tt><tt class="py-op">.</tt><tt class="py-name">get_boundary</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'content-type'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'multipart/related; '</tt> </tt>
+<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"> <tt class="py-string">'boundary="%s"'</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> <tt class="py-name">multipart_boundary</tt> </tt>
+<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt class="py-name">_add_query_parameter</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-string">'uploadType'</tt><tt class="py-op">,</tt> <tt class="py-string">'multipart'</tt><tt class="py-op">)</tt> </tt>
+<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"> </tt>
+<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"> <tt id="link-218" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-218', 'logger', 'link-50');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'URL being requested: %s %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">httpMethod</tt><tt class="py-op">,</tt><tt class="py-name">url</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requestBuilder</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_http</tt><tt class="py-op">,</tt> </tt>
+<a name="L842"></a><tt class="py-lineno"> 842</tt> <tt class="py-line"> <tt id="link-219" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-219', 'model', 'link-39');">model</a></tt><tt class="py-op">.</tt><tt id="link-220" class="py-name" targets="Method googleapiclient.model.BaseModel.response()=googleapiclient.model.BaseModel-class.html#response,Method googleapiclient.model.Model.response()=googleapiclient.model.Model-class.html#response"><a title="googleapiclient.model.BaseModel.response
+googleapiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-220', 'response', 'link-220');">response</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"> <tt class="py-name">url</tt><tt class="py-op">,</tt> </tt>
+<a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"> <tt class="py-name">method</tt><tt class="py-op">=</tt><tt class="py-name">httpMethod</tt><tt class="py-op">,</tt> </tt>
+<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"> <tt id="link-221" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-221', 'body', 'link-136');">body</a></tt><tt class="py-op">=</tt><tt id="link-222" class="py-name"><a title="googleapiclient.channel.Channel.body" class="py-name" href="#" onclick="return doclink('link-222', 'body', 'link-136');">body</a></tt><tt class="py-op">,</tt> </tt>
+<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">=</tt><tt class="py-name">headers</tt><tt class="py-op">,</tt> </tt>
+<a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"> <tt class="py-name">methodId</tt><tt class="py-op">=</tt><tt class="py-name">methodId</tt><tt class="py-op">,</tt> </tt>
+<a name="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"> <tt id="link-223" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
+googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-223', 'resumable', 'link-191');">resumable</a></tt><tt class="py-op">=</tt><tt id="link-224" class="py-name"><a title="googleapiclient.http.MediaIoBaseUpload.resumable
+googleapiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-224', 'resumable', 'link-191');">resumable</a></tt><tt class="py-op">)</tt> </tt>
+</div><a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"> </tt>
+<a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">methodDesc</tt><tt class="py-op">.</tt><tt id="link-225" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-219', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt id="link-220" class="py-name"><a title="googleapiclient.discovery.DEFAULT_METHOD_DOC" class="py-name" href="#" onclick="return doclink('link-220', 'DEFAULT_METHOD_DOC', 'link-51');">DEFAULT_METHOD_DOC</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-string">'\n\n'</tt><tt class="py-op">]</tt> </tt>
-<a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
-<a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'Args:\n'</tt><tt class="py-op">)</tt> </tt>
-<a name="L851"></a><tt class="py-lineno"> 851</tt> <tt class="py-line"> </tt>
-<a name="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"> <tt class="py-comment"># Skip undocumented params and params common to all methods.</tt> </tt>
-<a name="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"> <tt class="py-name">skip_parameters</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">rootDesc</tt><tt class="py-op">.</tt><tt id="link-221" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-225', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt id="link-226" class="py-name"><a title="googleapiclient.discovery.DEFAULT_METHOD_DOC" class="py-name" href="#" onclick="return doclink('link-226', 'DEFAULT_METHOD_DOC', 'link-57');">DEFAULT_METHOD_DOC</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-string">'\n\n'</tt><tt class="py-op">]</tt> </tt>
+<a name="L851"></a><tt class="py-lineno"> 851</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
+<a name="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'Args:\n'</tt><tt class="py-op">)</tt> </tt>
+<a name="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"> </tt>
+<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"> <tt class="py-comment"># Skip undocumented params and params common to all methods.</tt> </tt>
+<a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"> <tt class="py-name">skip_parameters</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">rootDesc</tt><tt class="py-op">.</tt><tt id="link-227" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-221', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'parameters'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"> <tt class="py-name">skip_parameters</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt id="link-222" class="py-name"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETERS" class="py-name" href="#" onclick="return doclink('link-222', 'STACK_QUERY_PARAMETERS', 'link-56');">STACK_QUERY_PARAMETERS</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"> </tt>
-<a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"> <tt class="py-name">all_args</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"> <tt class="py-name">args_ordered</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-223" class="py-name"><a title="googleapiclient.discovery.key2param" class="py-name" href="#" onclick="return doclink('link-223', 'key2param', 'link-154');">key2param</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">s</tt> <tt class="py-keyword">in</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">.</tt><tt id="link-224" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-227', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'parameters'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"> <tt class="py-name">skip_parameters</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt id="link-228" class="py-name"><a title="googleapiclient.discovery.STACK_QUERY_PARAMETERS" class="py-name" href="#" onclick="return doclink('link-228', 'STACK_QUERY_PARAMETERS', 'link-62');">STACK_QUERY_PARAMETERS</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"> </tt>
+<a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"> <tt class="py-name">all_args</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"> <tt class="py-name">args_ordered</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-229" class="py-name"><a title="googleapiclient.discovery.key2param" class="py-name" href="#" onclick="return doclink('link-229', 'key2param', 'link-160');">key2param</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">s</tt> <tt class="py-keyword">in</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">.</tt><tt id="link-230" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-224', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'parameterOrder'</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
-<a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"> </tt>
-<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"> <tt class="py-comment"># Move body to the front of the line.</tt> </tt>
-<a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'body'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">all_args</tt><tt class="py-op">:</tt> </tt>
-<a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"> <tt class="py-name">args_ordered</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'body'</tt><tt class="py-op">)</tt> </tt>
-<a name="L862"></a><tt class="py-lineno"> 862</tt> <tt class="py-line"> </tt>
-<a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">all_args</tt><tt class="py-op">:</tt> </tt>
-<a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">args_ordered</tt><tt class="py-op">:</tt> </tt>
-<a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"> <tt class="py-name">args_ordered</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
-<a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"> </tt>
-<a name="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">arg</tt> <tt class="py-keyword">in</tt> <tt class="py-name">args_ordered</tt><tt class="py-op">:</tt> </tt>
-<a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">arg</tt> <tt class="py-keyword">in</tt> <tt class="py-name">skip_parameters</tt><tt class="py-op">:</tt> </tt>
-<a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
-<a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"> </tt>
-<a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"> <tt class="py-name">repeated</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
-<a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">arg</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">repeated_params</tt><tt class="py-op">:</tt> </tt>
-<a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"> <tt class="py-name">repeated</tt> <tt class="py-op">=</tt> <tt class="py-string">' (repeated)'</tt> </tt>
-<a name="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"> <tt class="py-name">required</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
-<a name="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">arg</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">required_params</tt><tt class="py-op">:</tt> </tt>
-<a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"> <tt class="py-name">required</tt> <tt class="py-op">=</tt> <tt class="py-string">' (required)'</tt> </tt>
-<a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"> <tt class="py-name">paramdesc</tt> <tt class="py-op">=</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">[</tt><tt class="py-string">'parameters'</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">[</tt><tt class="py-name">arg</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
-<a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"> <tt class="py-name">paramdoc</tt> <tt class="py-op">=</tt> <tt class="py-name">paramdesc</tt><tt class="py-op">.</tt><tt id="link-225" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-230', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'parameterOrder'</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
+<a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"> </tt>
+<a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"> <tt class="py-comment"># Move body to the front of the line.</tt> </tt>
+<a name="L862"></a><tt class="py-lineno"> 862</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'body'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">all_args</tt><tt class="py-op">:</tt> </tt>
+<a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"> <tt class="py-name">args_ordered</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'body'</tt><tt class="py-op">)</tt> </tt>
+<a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"> </tt>
+<a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">all_args</tt><tt class="py-op">:</tt> </tt>
+<a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">args_ordered</tt><tt class="py-op">:</tt> </tt>
+<a name="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"> <tt class="py-name">args_ordered</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
+<a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"> </tt>
+<a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">arg</tt> <tt class="py-keyword">in</tt> <tt class="py-name">args_ordered</tt><tt class="py-op">:</tt> </tt>
+<a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">arg</tt> <tt class="py-keyword">in</tt> <tt class="py-name">skip_parameters</tt><tt class="py-op">:</tt> </tt>
+<a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
+<a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"> </tt>
+<a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"> <tt class="py-name">repeated</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
+<a name="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">arg</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">repeated_params</tt><tt class="py-op">:</tt> </tt>
+<a name="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"> <tt class="py-name">repeated</tt> <tt class="py-op">=</tt> <tt class="py-string">' (repeated)'</tt> </tt>
+<a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"> <tt class="py-name">required</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
+<a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">arg</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">required_params</tt><tt class="py-op">:</tt> </tt>
+<a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"> <tt class="py-name">required</tt> <tt class="py-op">=</tt> <tt class="py-string">' (required)'</tt> </tt>
+<a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"> <tt class="py-name">paramdesc</tt> <tt class="py-op">=</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">[</tt><tt class="py-string">'parameters'</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-name">parameters</tt><tt class="py-op">.</tt><tt class="py-name">argmap</tt><tt class="py-op">[</tt><tt class="py-name">arg</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
+<a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"> <tt class="py-name">paramdoc</tt> <tt class="py-op">=</tt> <tt class="py-name">paramdesc</tt><tt class="py-op">.</tt><tt id="link-231" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-225', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">'A parameter'</tt><tt class="py-op">)</tt> </tt>
-<a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'$ref'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">paramdesc</tt><tt class="py-op">:</tt> </tt>
-<a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> </tt>
-<a name="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">' %s: object, %s%s%s\n The object takes the'</tt> </tt>
-<a name="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"> <tt class="py-string">' form of:\n\n%s\n\n'</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">arg</tt><tt class="py-op">,</tt> <tt class="py-name">paramdoc</tt><tt class="py-op">,</tt> <tt class="py-name">required</tt><tt class="py-op">,</tt> <tt class="py-name">repeated</tt><tt class="py-op">,</tt> </tt>
-<a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"> <tt id="link-226" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-226', 'schema', 'link-42');">schema</a></tt><tt class="py-op">.</tt><tt id="link-227" class="py-name" targets="Method googleapiclient.schema.Schemas.prettyPrintByName()=googleapiclient.schema.Schemas-class.html#prettyPrintByName"><a title="googleapiclient.schema.Schemas.prettyPrintByName" class="py-name" href="#" onclick="return doclink('link-227', 'prettyPrintByName', 'link-227');">prettyPrintByName</a></tt><tt class="py-op">(</tt><tt class="py-name">paramdesc</tt><tt class="py-op">[</tt><tt class="py-string">'$ref'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L884"></a><tt class="py-lineno"> 884</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"> <tt class="py-name">paramtype</tt> <tt class="py-op">=</tt> <tt class="py-name">paramdesc</tt><tt class="py-op">.</tt><tt id="link-228" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-231', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">'A parameter'</tt><tt class="py-op">)</tt> </tt>
+<a name="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'$ref'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">paramdesc</tt><tt class="py-op">:</tt> </tt>
+<a name="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> </tt>
+<a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">' %s: object, %s%s%s\n The object takes the'</tt> </tt>
+<a name="L884"></a><tt class="py-lineno"> 884</tt> <tt class="py-line"> <tt class="py-string">' form of:\n\n%s\n\n'</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">arg</tt><tt class="py-op">,</tt> <tt class="py-name">paramdoc</tt><tt class="py-op">,</tt> <tt class="py-name">required</tt><tt class="py-op">,</tt> <tt class="py-name">repeated</tt><tt class="py-op">,</tt> </tt>
+<a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"> <tt id="link-232" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-232', 'schema', 'link-48');">schema</a></tt><tt class="py-op">.</tt><tt id="link-233" class="py-name" targets="Method googleapiclient.schema.Schemas.prettyPrintByName()=googleapiclient.schema.Schemas-class.html#prettyPrintByName"><a title="googleapiclient.schema.Schemas.prettyPrintByName" class="py-name" href="#" onclick="return doclink('link-233', 'prettyPrintByName', 'link-233');">prettyPrintByName</a></tt><tt class="py-op">(</tt><tt class="py-name">paramdesc</tt><tt class="py-op">[</tt><tt class="py-string">'$ref'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"> <tt class="py-name">paramtype</tt> <tt class="py-op">=</tt> <tt class="py-name">paramdesc</tt><tt class="py-op">.</tt><tt id="link-234" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-228', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'type'</tt><tt class="py-op">,</tt> <tt class="py-string">'string'</tt><tt class="py-op">)</tt> </tt>
-<a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' %s: %s, %s%s%s\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">arg</tt><tt class="py-op">,</tt> <tt class="py-name">paramtype</tt><tt class="py-op">,</tt> <tt class="py-name">paramdoc</tt><tt class="py-op">,</tt> <tt class="py-name">required</tt><tt class="py-op">,</tt> </tt>
-<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"> <tt class="py-name">repeated</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"> <tt class="py-name">enum</tt> <tt class="py-op">=</tt> <tt class="py-name">paramdesc</tt><tt class="py-op">.</tt><tt id="link-229" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-234', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'type'</tt><tt class="py-op">,</tt> <tt class="py-string">'string'</tt><tt class="py-op">)</tt> </tt>
+<a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' %s: %s, %s%s%s\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">arg</tt><tt class="py-op">,</tt> <tt class="py-name">paramtype</tt><tt class="py-op">,</tt> <tt class="py-name">paramdoc</tt><tt class="py-op">,</tt> <tt class="py-name">required</tt><tt class="py-op">,</tt> </tt>
+<a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"> <tt class="py-name">repeated</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"> <tt class="py-name">enum</tt> <tt class="py-op">=</tt> <tt class="py-name">paramdesc</tt><tt class="py-op">.</tt><tt id="link-235" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-229', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'enum'</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"> <tt class="py-name">enumDesc</tt> <tt class="py-op">=</tt> <tt class="py-name">paramdesc</tt><tt class="py-op">.</tt><tt id="link-230" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-235', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'enum'</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"> <tt class="py-name">enumDesc</tt> <tt class="py-op">=</tt> <tt class="py-name">paramdesc</tt><tt class="py-op">.</tt><tt id="link-236" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-230', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'enumDescriptions'</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">enum</tt> <tt class="py-keyword">and</tt> <tt class="py-name">enumDesc</tt><tt class="py-op">:</tt> </tt>
-<a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' Allowed values\n'</tt><tt class="py-op">)</tt> </tt>
-<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">desc</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">zip</tt><tt class="py-op">(</tt><tt class="py-name">enum</tt><tt class="py-op">,</tt> <tt class="py-name">enumDesc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' %s - %s\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">desc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'response'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">:</tt> </tt>
-<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">methodName</tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'_media'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'\nReturns:\n The media object as a string.\n\n '</tt><tt class="py-op">)</tt> </tt>
-<a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'\nReturns:\n An object of the form:\n\n '</tt><tt class="py-op">)</tt> </tt>
-<a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-231" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-231', 'schema', 'link-42');">schema</a></tt><tt class="py-op">.</tt><tt id="link-232" class="py-name" targets="Method googleapiclient.schema.Schemas.prettyPrintSchema()=googleapiclient.schema.Schemas-class.html#prettyPrintSchema"><a title="googleapiclient.schema.Schemas.prettyPrintSchema" class="py-name" href="#" onclick="return doclink('link-232', 'prettyPrintSchema', 'link-232');">prettyPrintSchema</a></tt><tt class="py-op">(</tt><tt class="py-name">methodDesc</tt><tt class="py-op">[</tt><tt class="py-string">'response'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"> </tt>
-<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">method</tt><tt class="py-op">,</tt> <tt class="py-string">'__doc__'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">docs</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L902"></a><tt class="py-lineno"> 902</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"> </tt>
-<a name="createNextMethod"></a><div id="createNextMethod-def"><a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"> </tt>
-<a name="L905"></a><tt class="py-lineno"> 905</tt> <a class="py-toggle" href="#" id="createNextMethod-toggle" onclick="return toggle('createNextMethod');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#createNextMethod">createNextMethod</a><tt class="py-op">(</tt><tt class="py-param">methodName</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="createNextMethod-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="createNextMethod-expanded"><a name="L906"></a><tt class="py-lineno"> 906</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates any _next methods for attaching to a Resource.</tt> </tt>
-<a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"><tt class="py-docstring"> The _next methods allow for easy iteration through list() responses.</tt> </tt>
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-236', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'enumDescriptions'</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">enum</tt> <tt class="py-keyword">and</tt> <tt class="py-name">enumDesc</tt><tt class="py-op">:</tt> </tt>
+<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' Allowed values\n'</tt><tt class="py-op">)</tt> </tt>
+<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">desc</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">zip</tt><tt class="py-op">(</tt><tt class="py-name">enum</tt><tt class="py-op">,</tt> <tt class="py-name">enumDesc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' %s - %s\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">desc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'response'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">:</tt> </tt>
+<a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">methodName</tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'_media'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'\nReturns:\n The media object as a string.\n\n '</tt><tt class="py-op">)</tt> </tt>
+<a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'\nReturns:\n An object of the form:\n\n '</tt><tt class="py-op">)</tt> </tt>
+<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-237" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-237', 'schema', 'link-48');">schema</a></tt><tt class="py-op">.</tt><tt id="link-238" class="py-name" targets="Method googleapiclient.schema.Schemas.prettyPrintSchema()=googleapiclient.schema.Schemas-class.html#prettyPrintSchema"><a title="googleapiclient.schema.Schemas.prettyPrintSchema" class="py-name" href="#" onclick="return doclink('link-238', 'prettyPrintSchema', 'link-238');">prettyPrintSchema</a></tt><tt class="py-op">(</tt><tt class="py-name">methodDesc</tt><tt class="py-op">[</tt><tt class="py-string">'response'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L902"></a><tt class="py-lineno"> 902</tt> <tt class="py-line"> </tt>
+<a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">method</tt><tt class="py-op">,</tt> <tt class="py-string">'__doc__'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">docs</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L905"></a><tt class="py-lineno"> 905</tt> <tt class="py-line"> </tt>
+<a name="createNextMethod"></a><div id="createNextMethod-def"><a name="L906"></a><tt class="py-lineno"> 906</tt> <tt class="py-line"> </tt>
+<a name="L907"></a><tt class="py-lineno"> 907</tt> <a class="py-toggle" href="#" id="createNextMethod-toggle" onclick="return toggle('createNextMethod');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery-module.html#createNextMethod">createNextMethod</a><tt class="py-op">(</tt><tt class="py-param">methodName</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="createNextMethod-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="createNextMethod-expanded"><a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates any _next methods for attaching to a Resource.</tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"><tt class="py-docstring"> methodName: string, name of the method to use.</tt> </tt>
-<a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">=</tt> <tt id="link-233" class="py-name"><a title="googleapiclient.discovery.fix_method_name" class="py-name" href="#" onclick="return doclink('link-233', 'fix_method_name', 'link-167');">fix_method_name</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">)</tt> </tt>
-<a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> </tt>
-<a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">methodNext</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">previous_request</tt><tt class="py-op">,</tt> <tt class="py-param">previous_response</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"> <tt class="py-docstring">"""Retrieves the next page of results.</tt> </tt>
-<a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L918"></a><tt class="py-lineno"> 918</tt> <tt class="py-line"><tt class="py-docstring">Args:</tt> </tt>
-<a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"><tt class="py-docstring"> previous_request: The request for the previous page. (required)</tt> </tt>
-<a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"><tt class="py-docstring"> previous_response: The response from the request for the previous page. (required)</tt> </tt>
-<a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"><tt class="py-docstring">Returns:</tt> </tt>
-<a name="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"><tt class="py-docstring"> A request object that you can call 'execute()' on to request the next</tt> </tt>
-<a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"><tt class="py-docstring"> page. Returns None if there are no more items in the collection.</tt> </tt>
-<a name="L925"></a><tt class="py-lineno"> 925</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"> <tt class="py-comment"># Retrieve nextPageToken from previous_response</tt> </tt>
-<a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"> <tt class="py-comment"># Use as pageToken in previous_request to create new request.</tt> </tt>
-<a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"> </tt>
-<a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'nextPageToken'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">previous_response</tt> <tt class="py-keyword">or</tt> <tt class="py-keyword">not</tt> <tt class="py-name">previous_response</tt><tt class="py-op">[</tt><tt class="py-string">'nextPageToken'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
-<a name="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
-<a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"> </tt>
-<a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"> <tt id="link-234" class="py-name"><a title="googleapiclient.http.HttpMock.request
-googleapiclient.http.HttpMockSequence.request
-googleapiclient.model.BaseModel.request
-googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-234', 'request', 'link-89');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">copy</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-name">previous_request</tt><tt class="py-op">)</tt> </tt>
+<a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"><tt class="py-docstring"> The _next methods allow for easy iteration through list() responses.</tt> </tt>
+<a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"><tt class="py-docstring"> methodName: string, name of the method to use.</tt> </tt>
+<a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">=</tt> <tt id="link-239" class="py-name"><a title="googleapiclient.discovery.fix_method_name" class="py-name" href="#" onclick="return doclink('link-239', 'fix_method_name', 'link-173');">fix_method_name</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">)</tt> </tt>
+<a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"> </tt>
+<a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">methodNext</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">previous_request</tt><tt class="py-op">,</tt> <tt class="py-param">previous_response</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L918"></a><tt class="py-lineno"> 918</tt> <tt class="py-line"> <tt class="py-docstring">"""Retrieves the next page of results.</tt> </tt>
+<a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"><tt class="py-docstring">Args:</tt> </tt>
+<a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"><tt class="py-docstring"> previous_request: The request for the previous page. (required)</tt> </tt>
+<a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"><tt class="py-docstring"> previous_response: The response from the request for the previous page. (required)</tt> </tt>
+<a name="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"><tt class="py-docstring">Returns:</tt> </tt>
+<a name="L925"></a><tt class="py-lineno"> 925</tt> <tt class="py-line"><tt class="py-docstring"> A request object that you can call 'execute()' on to request the next</tt> </tt>
+<a name="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"><tt class="py-docstring"> page. Returns None if there are no more items in the collection.</tt> </tt>
+<a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"> <tt class="py-comment"># Retrieve nextPageToken from previous_response</tt> </tt>
+<a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"> <tt class="py-comment"># Use as pageToken in previous_request to create new request.</tt> </tt>
+<a name="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"> </tt>
+<a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'nextPageToken'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">previous_response</tt> <tt class="py-keyword">or</tt> <tt class="py-keyword">not</tt> <tt class="py-name">previous_response</tt><tt class="py-op">[</tt><tt class="py-string">'nextPageToken'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
+<a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L933"></a><tt class="py-lineno"> 933</tt> <tt class="py-line"> </tt>
-<a name="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"> <tt class="py-name">pageToken</tt> <tt class="py-op">=</tt> <tt class="py-name">previous_response</tt><tt class="py-op">[</tt><tt class="py-string">'nextPageToken'</tt><tt class="py-op">]</tt> </tt>
-<a name="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"> <tt class="py-name">parsed</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">urlparse</tt><tt class="py-op">(</tt><tt id="link-235" class="py-name"><a title="googleapiclient.http.HttpMock.request
+<a name="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"> <tt id="link-240" class="py-name"><a title="googleapiclient.http.HttpMock.request
googleapiclient.http.HttpMockSequence.request
googleapiclient.model.BaseModel.request
-googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-235', 'request', 'link-89');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> <tt class="py-name">q</tt> <tt class="py-op">=</tt> <tt class="py-name">parse_qsl</tt><tt class="py-op">(</tt><tt class="py-name">parsed</tt><tt class="py-op">[</tt><tt class="py-number">4</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"> </tt>
-<a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"> <tt class="py-comment"># Find and remove old 'pageToken' value from URI</tt> </tt>
-<a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"> <tt class="py-name">newq</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">q</tt> <tt class="py-keyword">if</tt> <tt class="py-name">key</tt> <tt class="py-op">!=</tt> <tt class="py-string">'pageToken'</tt><tt class="py-op">]</tt> </tt>
-<a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"> <tt class="py-name">newq</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-string">'pageToken'</tt><tt class="py-op">,</tt> <tt class="py-name">pageToken</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L941"></a><tt class="py-lineno"> 941</tt> <tt class="py-line"> <tt class="py-name">parsed</tt><tt class="py-op">[</tt><tt class="py-number">4</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-name">newq</tt><tt class="py-op">)</tt> </tt>
-<a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"> <tt class="py-name">uri</tt> <tt class="py-op">=</tt> <tt class="py-name">urlunparse</tt><tt class="py-op">(</tt><tt class="py-name">parsed</tt><tt class="py-op">)</tt> </tt>
-<a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"> </tt>
-<a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"> <tt id="link-236" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-240', 'request', 'link-95');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">copy</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-name">previous_request</tt><tt class="py-op">)</tt> </tt>
+<a name="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"> </tt>
+<a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> <tt class="py-name">pageToken</tt> <tt class="py-op">=</tt> <tt class="py-name">previous_response</tt><tt class="py-op">[</tt><tt class="py-string">'nextPageToken'</tt><tt class="py-op">]</tt> </tt>
+<a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"> <tt class="py-name">parsed</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">urlparse</tt><tt class="py-op">(</tt><tt id="link-241" class="py-name"><a title="googleapiclient.http.HttpMock.request
googleapiclient.http.HttpMockSequence.request
googleapiclient.model.BaseModel.request
-googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-236', 'request', 'link-89');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">uri</tt> <tt class="py-op">=</tt> <tt class="py-name">uri</tt> </tt>
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-241', 'request', 'link-95');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"> <tt class="py-name">q</tt> <tt class="py-op">=</tt> <tt class="py-name">parse_qsl</tt><tt class="py-op">(</tt><tt class="py-name">parsed</tt><tt class="py-op">[</tt><tt class="py-number">4</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"> </tt>
+<a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"> <tt class="py-comment"># Find and remove old 'pageToken' value from URI</tt> </tt>
+<a name="L941"></a><tt class="py-lineno"> 941</tt> <tt class="py-line"> <tt class="py-name">newq</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">q</tt> <tt class="py-keyword">if</tt> <tt class="py-name">key</tt> <tt class="py-op">!=</tt> <tt class="py-string">'pageToken'</tt><tt class="py-op">]</tt> </tt>
+<a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"> <tt class="py-name">newq</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-string">'pageToken'</tt><tt class="py-op">,</tt> <tt class="py-name">pageToken</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"> <tt class="py-name">parsed</tt><tt class="py-op">[</tt><tt class="py-number">4</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-name">newq</tt><tt class="py-op">)</tt> </tt>
+<a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"> <tt class="py-name">uri</tt> <tt class="py-op">=</tt> <tt class="py-name">urlunparse</tt><tt class="py-op">(</tt><tt class="py-name">parsed</tt><tt class="py-op">)</tt> </tt>
<a name="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"> </tt>
-<a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"> <tt id="link-237" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-237', 'logger', 'link-44');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'URL being requested: %s %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">,</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"> </tt>
-<a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-238" class="py-name"><a title="googleapiclient.http.HttpMock.request
+<a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"> <tt id="link-242" class="py-name"><a title="googleapiclient.http.HttpMock.request
googleapiclient.http.HttpMockSequence.request
googleapiclient.model.BaseModel.request
-googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-238', 'request', 'link-89');">request</a></tt> </tt>
-</div><a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"> </tt>
-<a name="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodNext</tt><tt class="py-op">)</tt> </tt>
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-242', 'request', 'link-95');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">uri</tt> <tt class="py-op">=</tt> <tt class="py-name">uri</tt> </tt>
+<a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"> </tt>
+<a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"> <tt id="link-243" class="py-name"><a title="googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-243', 'logger', 'link-50');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'URL being requested: %s %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">,</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"> </tt>
+<a name="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-244" class="py-name"><a title="googleapiclient.http.HttpMock.request
+googleapiclient.http.HttpMockSequence.request
+googleapiclient.model.BaseModel.request
+googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-244', 'request', 'link-95');">request</a></tt> </tt>
</div><a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"> </tt>
-<a name="Resource"></a><div id="Resource-def"><a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"> </tt>
-<a name="L953"></a><tt class="py-lineno"> 953</tt> <a class="py-toggle" href="#" id="Resource-toggle" onclick="return toggle('Resource');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html">Resource</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Resource-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Resource-expanded"><a name="L954"></a><tt class="py-lineno"> 954</tt> <tt class="py-line"> <tt class="py-docstring">"""A class for interacting with a resource."""</tt> </tt>
-<a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"> </tt>
-<a name="Resource.__init__"></a><div id="Resource.__init__-def"><a name="L956"></a><tt class="py-lineno"> 956</tt> <a class="py-toggle" href="#" id="Resource.__init__-toggle" onclick="return toggle('Resource.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">,</tt> <tt class="py-param">baseUrl</tt><tt class="py-op">,</tt> <tt class="py-param">model</tt><tt class="py-op">,</tt> <tt class="py-param">requestBuilder</tt><tt class="py-op">,</tt> <tt class="py-param">developerKey</tt><tt class="py-op">,</tt> </tt>
-<a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"> <tt class="py-param">resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-param">rootDesc</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Resource.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource.__init__-expanded"><a name="L958"></a><tt class="py-lineno"> 958</tt> <tt class="py-line"> <tt class="py-docstring">"""Build a Resource from the API description.</tt> </tt>
-<a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, Object to make http requests with.</tt> </tt>
-<a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"><tt class="py-docstring"> baseUrl: string, base URL for the API. All requests are relative to this</tt> </tt>
-<a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"><tt class="py-docstring"> URI.</tt> </tt>
-<a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"><tt class="py-docstring"> model: googleapiclient.Model, converts to and from the wire format.</tt> </tt>
-<a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"><tt class="py-docstring"> requestBuilder: class or callable that instantiates an</tt> </tt>
-<a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"><tt class="py-docstring"> googleapiclient.HttpRequest object.</tt> </tt>
-<a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"><tt class="py-docstring"> developerKey: string, key obtained from</tt> </tt>
-<a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"><tt class="py-docstring"> https://code.google.com/apis/console</tt> </tt>
-<a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"><tt class="py-docstring"> resourceDesc: object, section of deserialized discovery document that</tt> </tt>
-<a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"><tt class="py-docstring"> describes a resource. Note that the top level discovery document</tt> </tt>
-<a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"><tt class="py-docstring"> is considered a resource.</tt> </tt>
-<a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"><tt class="py-docstring"> rootDesc: object, the entire deserialized discovery document.</tt> </tt>
-<a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, mapping of schema names to schema descriptions.</tt> </tt>
-<a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_dynamic_attrs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
-<a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"> </tt>
-<a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_http</tt> <tt class="py-op">=</tt> <tt id="link-239" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-239', 'http', 'link-21');">http</a></tt> </tt>
-<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_baseUrl</tt> <tt class="py-op">=</tt> <tt class="py-name">baseUrl</tt> </tt>
-<a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt> <tt class="py-op">=</tt> <tt id="link-240" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-240', 'model', 'link-33');">model</a></tt> </tt>
-<a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_developerKey</tt> <tt class="py-op">=</tt> <tt class="py-name">developerKey</tt> </tt>
-<a name="L981"></a><tt class="py-lineno"> 981</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requestBuilder</tt> <tt class="py-op">=</tt> <tt class="py-name">requestBuilder</tt> </tt>
-<a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resourceDesc</tt> <tt class="py-op">=</tt> <tt class="py-name">resourceDesc</tt> </tt>
-<a name="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_rootDesc</tt> <tt class="py-op">=</tt> <tt class="py-name">rootDesc</tt> </tt>
-<a name="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_schema</tt> <tt class="py-op">=</tt> <tt id="link-241" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-241', 'schema', 'link-42');">schema</a></tt> </tt>
-<a name="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"> </tt>
-<a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-242" class="py-name" targets="Method googleapiclient.discovery.Resource._set_service_methods()=googleapiclient.discovery.Resource-class.html#_set_service_methods"><a title="googleapiclient.discovery.Resource._set_service_methods" class="py-name" href="#" onclick="return doclink('link-242', '_set_service_methods', 'link-242');">_set_service_methods</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"> </tt>
-<a name="Resource._set_dynamic_attr"></a><div id="Resource._set_dynamic_attr-def"><a name="L988"></a><tt class="py-lineno"> 988</tt> <a class="py-toggle" href="#" id="Resource._set_dynamic_attr-toggle" onclick="return toggle('Resource._set_dynamic_attr');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#_set_dynamic_attr">_set_dynamic_attr</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">attr_name</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Resource._set_dynamic_attr-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource._set_dynamic_attr-expanded"><a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"> <tt class="py-docstring">"""Sets an instance attribute and tracks it in a list of dynamic attributes.</tt> </tt>
-<a name="L990"></a><tt class="py-lineno"> 990</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"><tt class="py-docstring"> attr_name: string; The name of the attribute to be set</tt> </tt>
-<a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"><tt class="py-docstring"> value: The value being set on the object and tracked in the dynamic cache.</tt> </tt>
-<a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_dynamic_attrs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">attr_name</tt><tt class="py-op">)</tt> </tt>
-<a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">[</tt><tt class="py-name">attr_name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
-</div><a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"> </tt>
-<a name="Resource.__getstate__"></a><div id="Resource.__getstate__-def"><a name="L998"></a><tt class="py-lineno"> 998</tt> <a class="py-toggle" href="#" id="Resource.__getstate__-toggle" onclick="return toggle('Resource.__getstate__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#__getstate__">__getstate__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Resource.__getstate__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource.__getstate__-expanded"><a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"> <tt class="py-docstring">"""Trim the state down to something that can be pickled.</tt> </tt>
-<a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"><tt class="py-docstring"> Uses the fact that the instance variable _dynamic_attrs holds attrs that</tt> </tt>
-<a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"><tt class="py-docstring"> will be wiped and restored on pickle serialization.</tt> </tt>
-<a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"> <tt class="py-name">state_dict</tt> <tt class="py-op">=</tt> <tt class="py-name">copy</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">)</tt> </tt>
-<a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">dynamic_attr</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_dynamic_attrs</tt><tt class="py-op">:</tt> </tt>
-<a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">state_dict</tt><tt class="py-op">[</tt><tt class="py-name">dynamic_attr</tt><tt class="py-op">]</tt> </tt>
-<a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">state_dict</tt><tt class="py-op">[</tt><tt class="py-string">'_dynamic_attrs'</tt><tt class="py-op">]</tt> </tt>
-<a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">state_dict</tt> </tt>
-</div><a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"> </tt>
-<a name="Resource.__setstate__"></a><div id="Resource.__setstate__-def"><a name="L1010"></a><tt class="py-lineno">1010</tt> <a class="py-toggle" href="#" id="Resource.__setstate__-toggle" onclick="return toggle('Resource.__setstate__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#__setstate__">__setstate__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">state</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Resource.__setstate__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource.__setstate__-expanded"><a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"> <tt class="py-docstring">"""Reconstitute the state of the object from being pickled.</tt> </tt>
-<a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"><tt class="py-docstring"> Uses the fact that the instance variable _dynamic_attrs holds attrs that</tt> </tt>
-<a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"><tt class="py-docstring"> will be wiped and restored on pickle serialization.</tt> </tt>
-<a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt id="link-243" class="py-name"><a title="googleapiclient.channel.Channel.update" class="py-name" href="#" onclick="return doclink('link-243', 'update', 'link-133');">update</a></tt><tt class="py-op">(</tt><tt class="py-name">state</tt><tt class="py-op">)</tt> </tt>
-<a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_dynamic_attrs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
-<a name="L1018"></a><tt class="py-lineno">1018</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-244" class="py-name"><a title="googleapiclient.discovery.Resource._set_service_methods" class="py-name" href="#" onclick="return doclink('link-244', '_set_service_methods', 'link-242');">_set_service_methods</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"> </tt>
-<a name="Resource._set_service_methods"></a><div id="Resource._set_service_methods-def"><a name="L1020"></a><tt class="py-lineno">1020</tt> <a class="py-toggle" href="#" id="Resource._set_service_methods-toggle" onclick="return toggle('Resource._set_service_methods');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#_set_service_methods">_set_service_methods</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Resource._set_service_methods-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource._set_service_methods-expanded"><a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-245" class="py-name" targets="Method googleapiclient.discovery.Resource._add_basic_methods()=googleapiclient.discovery.Resource-class.html#_add_basic_methods"><a title="googleapiclient.discovery.Resource._add_basic_methods" class="py-name" href="#" onclick="return doclink('link-245', '_add_basic_methods', 'link-245');">_add_basic_methods</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_rootDesc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_schema</tt><tt class="py-op">)</tt> </tt>
-<a name="L1022"></a><tt class="py-lineno">1022</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-246" class="py-name" targets="Method googleapiclient.discovery.Resource._add_nested_resources()=googleapiclient.discovery.Resource-class.html#_add_nested_resources"><a title="googleapiclient.discovery.Resource._add_nested_resources" class="py-name" href="#" onclick="return doclink('link-246', '_add_nested_resources', 'link-246');">_add_nested_resources</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_rootDesc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_schema</tt><tt class="py-op">)</tt> </tt>
-<a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-247" class="py-name" targets="Method googleapiclient.discovery.Resource._add_next_methods()=googleapiclient.discovery.Resource-class.html#_add_next_methods"><a title="googleapiclient.discovery.Resource._add_next_methods" class="py-name" href="#" onclick="return doclink('link-247', '_add_next_methods', 'link-247');">_add_next_methods</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_schema</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"> </tt>
-<a name="Resource._add_basic_methods"></a><div id="Resource._add_basic_methods-def"><a name="L1025"></a><tt class="py-lineno">1025</tt> <a class="py-toggle" href="#" id="Resource._add_basic_methods-toggle" onclick="return toggle('Resource._add_basic_methods');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#_add_basic_methods">_add_basic_methods</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-param">rootDesc</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Resource._add_basic_methods-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource._add_basic_methods-expanded"><a name="L1026"></a><tt class="py-lineno">1026</tt> <tt class="py-line"> <tt class="py-comment"># If this is the root Resource, add a new_batch_http_request() method.</tt> </tt>
-<a name="L1027"></a><tt class="py-lineno">1027</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resourceDesc</tt> <tt class="py-op">==</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">:</tt> </tt>
-<a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"> <tt class="py-name">batch_uri</tt> <tt class="py-op">=</tt> <tt class="py-string">'%s%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt>
-<a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"> <tt class="py-name">rootDesc</tt><tt class="py-op">[</tt><tt class="py-string">'rootUrl'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">.</tt><tt id="link-248" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+<a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodNext</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"> </tt>
+<a name="Resource"></a><div id="Resource-def"><a name="L954"></a><tt class="py-lineno"> 954</tt> <tt class="py-line"> </tt>
+<a name="L955"></a><tt class="py-lineno"> 955</tt> <a class="py-toggle" href="#" id="Resource-toggle" onclick="return toggle('Resource');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html">Resource</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Resource-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Resource-expanded"><a name="L956"></a><tt class="py-lineno"> 956</tt> <tt class="py-line"> <tt class="py-docstring">"""A class for interacting with a resource."""</tt> </tt>
+<a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"> </tt>
+<a name="Resource.__init__"></a><div id="Resource.__init__-def"><a name="L958"></a><tt class="py-lineno"> 958</tt> <a class="py-toggle" href="#" id="Resource.__init__-toggle" onclick="return toggle('Resource.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">,</tt> <tt class="py-param">baseUrl</tt><tt class="py-op">,</tt> <tt class="py-param">model</tt><tt class="py-op">,</tt> <tt class="py-param">requestBuilder</tt><tt class="py-op">,</tt> <tt class="py-param">developerKey</tt><tt class="py-op">,</tt> </tt>
+<a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"> <tt class="py-param">resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-param">rootDesc</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Resource.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource.__init__-expanded"><a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"> <tt class="py-docstring">"""Build a Resource from the API description.</tt> </tt>
+<a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, Object to make http requests with.</tt> </tt>
+<a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"><tt class="py-docstring"> baseUrl: string, base URL for the API. All requests are relative to this</tt> </tt>
+<a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"><tt class="py-docstring"> URI.</tt> </tt>
+<a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"><tt class="py-docstring"> model: googleapiclient.Model, converts to and from the wire format.</tt> </tt>
+<a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"><tt class="py-docstring"> requestBuilder: class or callable that instantiates an</tt> </tt>
+<a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"><tt class="py-docstring"> googleapiclient.HttpRequest object.</tt> </tt>
+<a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"><tt class="py-docstring"> developerKey: string, key obtained from</tt> </tt>
+<a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"><tt class="py-docstring"> https://code.google.com/apis/console</tt> </tt>
+<a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"><tt class="py-docstring"> resourceDesc: object, section of deserialized discovery document that</tt> </tt>
+<a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"><tt class="py-docstring"> describes a resource. Note that the top level discovery document</tt> </tt>
+<a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"><tt class="py-docstring"> is considered a resource.</tt> </tt>
+<a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"><tt class="py-docstring"> rootDesc: object, the entire deserialized discovery document.</tt> </tt>
+<a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, mapping of schema names to schema descriptions.</tt> </tt>
+<a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_dynamic_attrs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
+<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"> </tt>
+<a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_http</tt> <tt class="py-op">=</tt> <tt id="link-245" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-245', 'http', 'link-21');">http</a></tt> </tt>
+<a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_baseUrl</tt> <tt class="py-op">=</tt> <tt class="py-name">baseUrl</tt> </tt>
+<a name="L981"></a><tt class="py-lineno"> 981</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt> <tt class="py-op">=</tt> <tt id="link-246" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-246', 'model', 'link-39');">model</a></tt> </tt>
+<a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_developerKey</tt> <tt class="py-op">=</tt> <tt class="py-name">developerKey</tt> </tt>
+<a name="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requestBuilder</tt> <tt class="py-op">=</tt> <tt class="py-name">requestBuilder</tt> </tt>
+<a name="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resourceDesc</tt> <tt class="py-op">=</tt> <tt class="py-name">resourceDesc</tt> </tt>
+<a name="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_rootDesc</tt> <tt class="py-op">=</tt> <tt class="py-name">rootDesc</tt> </tt>
+<a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_schema</tt> <tt class="py-op">=</tt> <tt id="link-247" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-247', 'schema', 'link-48');">schema</a></tt> </tt>
+<a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"> </tt>
+<a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-248" class="py-name" targets="Method googleapiclient.discovery.Resource._set_service_methods()=googleapiclient.discovery.Resource-class.html#_set_service_methods"><a title="googleapiclient.discovery.Resource._set_service_methods" class="py-name" href="#" onclick="return doclink('link-248', '_set_service_methods', 'link-248');">_set_service_methods</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"> </tt>
+<a name="Resource._set_dynamic_attr"></a><div id="Resource._set_dynamic_attr-def"><a name="L990"></a><tt class="py-lineno"> 990</tt> <a class="py-toggle" href="#" id="Resource._set_dynamic_attr-toggle" onclick="return toggle('Resource._set_dynamic_attr');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#_set_dynamic_attr">_set_dynamic_attr</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">attr_name</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Resource._set_dynamic_attr-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource._set_dynamic_attr-expanded"><a name="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"> <tt class="py-docstring">"""Sets an instance attribute and tracks it in a list of dynamic attributes.</tt> </tt>
+<a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"><tt class="py-docstring"> attr_name: string; The name of the attribute to be set</tt> </tt>
+<a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"><tt class="py-docstring"> value: The value being set on the object and tracked in the dynamic cache.</tt> </tt>
+<a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_dynamic_attrs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">attr_name</tt><tt class="py-op">)</tt> </tt>
+<a name="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">[</tt><tt class="py-name">attr_name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
+</div><a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"> </tt>
+<a name="Resource.__getstate__"></a><div id="Resource.__getstate__-def"><a name="L1000"></a><tt class="py-lineno">1000</tt> <a class="py-toggle" href="#" id="Resource.__getstate__-toggle" onclick="return toggle('Resource.__getstate__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#__getstate__">__getstate__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Resource.__getstate__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource.__getstate__-expanded"><a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"> <tt class="py-docstring">"""Trim the state down to something that can be pickled.</tt> </tt>
+<a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"><tt class="py-docstring"> Uses the fact that the instance variable _dynamic_attrs holds attrs that</tt> </tt>
+<a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"><tt class="py-docstring"> will be wiped and restored on pickle serialization.</tt> </tt>
+<a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"> <tt class="py-name">state_dict</tt> <tt class="py-op">=</tt> <tt class="py-name">copy</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">)</tt> </tt>
+<a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">dynamic_attr</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_dynamic_attrs</tt><tt class="py-op">:</tt> </tt>
+<a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">state_dict</tt><tt class="py-op">[</tt><tt class="py-name">dynamic_attr</tt><tt class="py-op">]</tt> </tt>
+<a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">state_dict</tt><tt class="py-op">[</tt><tt class="py-string">'_dynamic_attrs'</tt><tt class="py-op">]</tt> </tt>
+<a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">state_dict</tt> </tt>
+</div><a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"> </tt>
+<a name="Resource.__setstate__"></a><div id="Resource.__setstate__-def"><a name="L1012"></a><tt class="py-lineno">1012</tt> <a class="py-toggle" href="#" id="Resource.__setstate__-toggle" onclick="return toggle('Resource.__setstate__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#__setstate__">__setstate__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">state</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Resource.__setstate__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource.__setstate__-expanded"><a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"> <tt class="py-docstring">"""Reconstitute the state of the object from being pickled.</tt> </tt>
+<a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"><tt class="py-docstring"> Uses the fact that the instance variable _dynamic_attrs holds attrs that</tt> </tt>
+<a name="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"><tt class="py-docstring"> will be wiped and restored on pickle serialization.</tt> </tt>
+<a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L1018"></a><tt class="py-lineno">1018</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt id="link-249" class="py-name"><a title="googleapiclient.channel.Channel.update" class="py-name" href="#" onclick="return doclink('link-249', 'update', 'link-139');">update</a></tt><tt class="py-op">(</tt><tt class="py-name">state</tt><tt class="py-op">)</tt> </tt>
+<a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_dynamic_attrs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
+<a name="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-250" class="py-name"><a title="googleapiclient.discovery.Resource._set_service_methods" class="py-name" href="#" onclick="return doclink('link-250', '_set_service_methods', 'link-248');">_set_service_methods</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"> </tt>
+<a name="Resource._set_service_methods"></a><div id="Resource._set_service_methods-def"><a name="L1022"></a><tt class="py-lineno">1022</tt> <a class="py-toggle" href="#" id="Resource._set_service_methods-toggle" onclick="return toggle('Resource._set_service_methods');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#_set_service_methods">_set_service_methods</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Resource._set_service_methods-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource._set_service_methods-expanded"><a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-251" class="py-name" targets="Method googleapiclient.discovery.Resource._add_basic_methods()=googleapiclient.discovery.Resource-class.html#_add_basic_methods"><a title="googleapiclient.discovery.Resource._add_basic_methods" class="py-name" href="#" onclick="return doclink('link-251', '_add_basic_methods', 'link-251');">_add_basic_methods</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_rootDesc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_schema</tt><tt class="py-op">)</tt> </tt>
+<a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-252" class="py-name" targets="Method googleapiclient.discovery.Resource._add_nested_resources()=googleapiclient.discovery.Resource-class.html#_add_nested_resources"><a title="googleapiclient.discovery.Resource._add_nested_resources" class="py-name" href="#" onclick="return doclink('link-252', '_add_nested_resources', 'link-252');">_add_nested_resources</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_rootDesc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_schema</tt><tt class="py-op">)</tt> </tt>
+<a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-253" class="py-name" targets="Method googleapiclient.discovery.Resource._add_next_methods()=googleapiclient.discovery.Resource-class.html#_add_next_methods"><a title="googleapiclient.discovery.Resource._add_next_methods" class="py-name" href="#" onclick="return doclink('link-253', '_add_next_methods', 'link-253');">_add_next_methods</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_schema</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L1026"></a><tt class="py-lineno">1026</tt> <tt class="py-line"> </tt>
+<a name="Resource._add_basic_methods"></a><div id="Resource._add_basic_methods-def"><a name="L1027"></a><tt class="py-lineno">1027</tt> <a class="py-toggle" href="#" id="Resource._add_basic_methods-toggle" onclick="return toggle('Resource._add_basic_methods');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#_add_basic_methods">_add_basic_methods</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-param">rootDesc</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Resource._add_basic_methods-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource._add_basic_methods-expanded"><a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"> <tt class="py-comment"># If this is the root Resource, add a new_batch_http_request() method.</tt> </tt>
+<a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resourceDesc</tt> <tt class="py-op">==</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">:</tt> </tt>
+<a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"> <tt class="py-name">batch_uri</tt> <tt class="py-op">=</tt> <tt class="py-string">'%s%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt>
+<a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"> <tt class="py-name">rootDesc</tt><tt class="py-op">[</tt><tt class="py-string">'rootUrl'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">.</tt><tt id="link-254" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-248', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'batchPath'</tt><tt class="py-op">,</tt> <tt class="py-string">'batch'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">new_batch_http_request</tt><tt class="py-op">(</tt><tt class="py-param">callback</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a BatchHttpRequest object based on the discovery document.</tt> </tt>
-<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"><tt class="py-docstring"> callback: callable, A callback to be called for each response, of the</tt> </tt>
-<a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"><tt class="py-docstring"> form callback(id, response, exception). The first parameter is the</tt> </tt>
-<a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"><tt class="py-docstring"> request id, and the second is the deserialized response object. The</tt> </tt>
-<a name="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"><tt class="py-docstring"> third is an apiclient.errors.HttpError exception object if an HTTP</tt> </tt>
-<a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"><tt class="py-docstring"> error occurred while processing the request, or None if no error</tt> </tt>
-<a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"><tt class="py-docstring"> occurred.</tt> </tt>
-<a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
-<a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"><tt class="py-docstring"> A BatchHttpRequest object based on the discovery document.</tt> </tt>
-<a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-249" class="py-name"><a title="googleapiclient.http.BatchHttpRequest" class="py-name" href="#" onclick="return doclink('link-249', 'BatchHttpRequest', 'link-22');">BatchHttpRequest</a></tt><tt class="py-op">(</tt><tt class="py-name">callback</tt><tt class="py-op">=</tt><tt class="py-name">callback</tt><tt class="py-op">,</tt> <tt class="py-name">batch_uri</tt><tt class="py-op">=</tt><tt class="py-name">batch_uri</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L1045"></a><tt class="py-lineno">1045</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-250" class="py-name" targets="Method googleapiclient.discovery.Resource._set_dynamic_attr()=googleapiclient.discovery.Resource-class.html#_set_dynamic_attr"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-250', '_set_dynamic_attr', 'link-250');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-string">'new_batch_http_request'</tt><tt class="py-op">,</tt> <tt class="py-name">new_batch_http_request</tt><tt class="py-op">)</tt> </tt>
-<a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"> </tt>
-<a name="L1047"></a><tt class="py-lineno">1047</tt> <tt class="py-line"> <tt class="py-comment"># Add basic methods to Resource</tt> </tt>
-<a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'methods'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resourceDesc</tt><tt class="py-op">:</tt> </tt>
-<a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodDesc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">resourceDesc</tt><tt class="py-op">[</tt><tt class="py-string">'methods'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"> <tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt id="link-251" class="py-name" targets="Function googleapiclient.discovery.createMethod()=googleapiclient.discovery-module.html#createMethod"><a title="googleapiclient.discovery.createMethod" class="py-name" href="#" onclick="return doclink('link-251', 'createMethod', 'link-251');">createMethod</a></tt><tt class="py-op">(</tt> </tt>
-<a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"> <tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">,</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">,</tt> <tt id="link-252" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-252', 'schema', 'link-42');">schema</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-253" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-253', '_set_dynamic_attr', 'link-250');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
-<a name="L1053"></a><tt class="py-lineno">1053</tt> <tt class="py-line"> <tt class="py-name">method</tt><tt class="py-op">.</tt><tt class="py-name">__get__</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"> <tt class="py-comment"># Add in _media methods. The functionality of the attached method will</tt> </tt>
-<a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"> <tt class="py-comment"># change when it sees that the method name ends in _media.</tt> </tt>
-<a name="L1056"></a><tt class="py-lineno">1056</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">.</tt><tt id="link-254" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-254', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'batchPath'</tt><tt class="py-op">,</tt> <tt class="py-string">'batch'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">new_batch_http_request</tt><tt class="py-op">(</tt><tt class="py-param">callback</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a BatchHttpRequest object based on the discovery document.</tt> </tt>
+<a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"><tt class="py-docstring"> callback: callable, A callback to be called for each response, of the</tt> </tt>
+<a name="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"><tt class="py-docstring"> form callback(id, response, exception). The first parameter is the</tt> </tt>
+<a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"><tt class="py-docstring"> request id, and the second is the deserialized response object. The</tt> </tt>
+<a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"><tt class="py-docstring"> third is an apiclient.errors.HttpError exception object if an HTTP</tt> </tt>
+<a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"><tt class="py-docstring"> error occurred while processing the request, or None if no error</tt> </tt>
+<a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"><tt class="py-docstring"> occurred.</tt> </tt>
+<a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
+<a name="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"><tt class="py-docstring"> A BatchHttpRequest object based on the discovery document.</tt> </tt>
+<a name="L1045"></a><tt class="py-lineno">1045</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-255" class="py-name"><a title="googleapiclient.http.BatchHttpRequest" class="py-name" href="#" onclick="return doclink('link-255', 'BatchHttpRequest', 'link-22');">BatchHttpRequest</a></tt><tt class="py-op">(</tt><tt class="py-name">callback</tt><tt class="py-op">=</tt><tt class="py-name">callback</tt><tt class="py-op">,</tt> <tt class="py-name">batch_uri</tt><tt class="py-op">=</tt><tt class="py-name">batch_uri</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L1047"></a><tt class="py-lineno">1047</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-256" class="py-name" targets="Method googleapiclient.discovery.Resource._set_dynamic_attr()=googleapiclient.discovery.Resource-class.html#_set_dynamic_attr"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-256', '_set_dynamic_attr', 'link-256');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-string">'new_batch_http_request'</tt><tt class="py-op">,</tt> <tt class="py-name">new_batch_http_request</tt><tt class="py-op">)</tt> </tt>
+<a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"> </tt>
+<a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"> <tt class="py-comment"># Add basic methods to Resource</tt> </tt>
+<a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'methods'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resourceDesc</tt><tt class="py-op">:</tt> </tt>
+<a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodDesc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">resourceDesc</tt><tt class="py-op">[</tt><tt class="py-string">'methods'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"> <tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt id="link-257" class="py-name" targets="Function googleapiclient.discovery.createMethod()=googleapiclient.discovery-module.html#createMethod"><a title="googleapiclient.discovery.createMethod" class="py-name" href="#" onclick="return doclink('link-257', 'createMethod', 'link-257');">createMethod</a></tt><tt class="py-op">(</tt> </tt>
+<a name="L1053"></a><tt class="py-lineno">1053</tt> <tt class="py-line"> <tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">,</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">,</tt> <tt id="link-258" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-258', 'schema', 'link-48');">schema</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-259" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-259', '_set_dynamic_attr', 'link-256');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
+<a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"> <tt class="py-name">method</tt><tt class="py-op">.</tt><tt class="py-name">__get__</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+<a name="L1056"></a><tt class="py-lineno">1056</tt> <tt class="py-line"> <tt class="py-comment"># Add in _media methods. The functionality of the attached method will</tt> </tt>
+<a name="L1057"></a><tt class="py-lineno">1057</tt> <tt class="py-line"> <tt class="py-comment"># change when it sees that the method name ends in _media.</tt> </tt>
+<a name="L1058"></a><tt class="py-lineno">1058</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">.</tt><tt id="link-260" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-254', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'supportsMediaDownload'</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L1057"></a><tt class="py-lineno">1057</tt> <tt class="py-line"> <tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt id="link-255" class="py-name"><a title="googleapiclient.discovery.createMethod" class="py-name" href="#" onclick="return doclink('link-255', 'createMethod', 'link-251');">createMethod</a></tt><tt class="py-op">(</tt> </tt>
-<a name="L1058"></a><tt class="py-lineno">1058</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">+</tt> <tt class="py-string">'_media'</tt><tt class="py-op">,</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">,</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">,</tt> <tt id="link-256" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-256', 'schema', 'link-42');">schema</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L1059"></a><tt class="py-lineno">1059</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-257" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-257', '_set_dynamic_attr', 'link-250');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
-<a name="L1060"></a><tt class="py-lineno">1060</tt> <tt class="py-line"> <tt class="py-name">method</tt><tt class="py-op">.</tt><tt class="py-name">__get__</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L1061"></a><tt class="py-lineno">1061</tt> <tt class="py-line"> </tt>
-<a name="Resource._add_nested_resources"></a><div id="Resource._add_nested_resources-def"><a name="L1062"></a><tt class="py-lineno">1062</tt> <a class="py-toggle" href="#" id="Resource._add_nested_resources-toggle" onclick="return toggle('Resource._add_nested_resources');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#_add_nested_resources">_add_nested_resources</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-param">rootDesc</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Resource._add_nested_resources-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource._add_nested_resources-expanded"><a name="L1063"></a><tt class="py-lineno">1063</tt> <tt class="py-line"> <tt class="py-comment"># Add in nested resources</tt> </tt>
-<a name="L1064"></a><tt class="py-lineno">1064</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'resources'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resourceDesc</tt><tt class="py-op">:</tt> </tt>
-<a name="L1065"></a><tt class="py-lineno">1065</tt> <tt class="py-line"> </tt>
-<a name="L1066"></a><tt class="py-lineno">1066</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">createResourceMethod</tt><tt class="py-op">(</tt><tt class="py-param">methodName</tt><tt class="py-op">,</tt> <tt class="py-param">methodDesc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L1067"></a><tt class="py-lineno">1067</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a method on the Resource to access a nested Resource.</tt> </tt>
-<a name="L1068"></a><tt class="py-lineno">1068</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L1069"></a><tt class="py-lineno">1069</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"><tt class="py-docstring"> methodName: string, name of the method to use.</tt> </tt>
-<a name="L1071"></a><tt class="py-lineno">1071</tt> <tt class="py-line"><tt class="py-docstring"> methodDesc: object, fragment of deserialized discovery document that</tt> </tt>
-<a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"><tt class="py-docstring"> describes the method.</tt> </tt>
-<a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">=</tt> <tt id="link-258" class="py-name"><a title="googleapiclient.discovery.fix_method_name" class="py-name" href="#" onclick="return doclink('link-258', 'fix_method_name', 'link-167');">fix_method_name</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">)</tt> </tt>
-<a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"> </tt>
-<a name="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">methodResource</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-259" class="py-name"><a title="googleapiclient.discovery.Resource" class="py-name" href="#" onclick="return doclink('link-259', 'Resource', 'link-116');">Resource</a></tt><tt class="py-op">(</tt><tt id="link-260" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-260', 'http', 'link-21');">http</a></tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_http</tt><tt class="py-op">,</tt> <tt class="py-name">baseUrl</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_baseUrl</tt><tt class="py-op">,</tt> </tt>
-<a name="L1078"></a><tt class="py-lineno">1078</tt> <tt class="py-line"> <tt id="link-261" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-261', 'model', 'link-33');">model</a></tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt><tt class="py-op">,</tt> <tt class="py-name">developerKey</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_developerKey</tt><tt class="py-op">,</tt> </tt>
-<a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"> <tt class="py-name">requestBuilder</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requestBuilder</tt><tt class="py-op">,</tt> </tt>
-<a name="L1080"></a><tt class="py-lineno">1080</tt> <tt class="py-line"> <tt class="py-name">resourceDesc</tt><tt class="py-op">=</tt><tt class="py-name">methodDesc</tt><tt class="py-op">,</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">=</tt><tt class="py-name">rootDesc</tt><tt class="py-op">,</tt> </tt>
-<a name="L1081"></a><tt class="py-lineno">1081</tt> <tt class="py-line"> <tt id="link-262" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-262', 'schema', 'link-42');">schema</a></tt><tt class="py-op">=</tt><tt id="link-263" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-263', 'schema', 'link-42');">schema</a></tt><tt class="py-op">)</tt> </tt>
-</div><a name="L1082"></a><tt class="py-lineno">1082</tt> <tt class="py-line"> </tt>
-<a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">methodResource</tt><tt class="py-op">,</tt> <tt class="py-string">'__doc__'</tt><tt class="py-op">,</tt> <tt class="py-string">'A collection resource.'</tt><tt class="py-op">)</tt> </tt>
-<a name="L1084"></a><tt class="py-lineno">1084</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">methodResource</tt><tt class="py-op">,</tt> <tt class="py-string">'__is_resource__'</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
-<a name="L1085"></a><tt class="py-lineno">1085</tt> <tt class="py-line"> </tt>
-<a name="L1086"></a><tt class="py-lineno">1086</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodResource</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L1087"></a><tt class="py-lineno">1087</tt> <tt class="py-line"> </tt>
-<a name="L1088"></a><tt class="py-lineno">1088</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodDesc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">resourceDesc</tt><tt class="py-op">[</tt><tt class="py-string">'resources'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L1089"></a><tt class="py-lineno">1089</tt> <tt class="py-line"> <tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt class="py-name">createResourceMethod</tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">)</tt> </tt>
-<a name="L1090"></a><tt class="py-lineno">1090</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-264" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-264', '_set_dynamic_attr', 'link-250');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
-<a name="L1091"></a><tt class="py-lineno">1091</tt> <tt class="py-line"> <tt class="py-name">method</tt><tt class="py-op">.</tt><tt class="py-name">__get__</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L1092"></a><tt class="py-lineno">1092</tt> <tt class="py-line"> </tt>
-<a name="Resource._add_next_methods"></a><div id="Resource._add_next_methods-def"><a name="L1093"></a><tt class="py-lineno">1093</tt> <a class="py-toggle" href="#" id="Resource._add_next_methods-toggle" onclick="return toggle('Resource._add_next_methods');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#_add_next_methods">_add_next_methods</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Resource._add_next_methods-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource._add_next_methods-expanded"><a name="L1094"></a><tt class="py-lineno">1094</tt> <tt class="py-line"> <tt class="py-comment"># Add _next() methods</tt> </tt>
-<a name="L1095"></a><tt class="py-lineno">1095</tt> <tt class="py-line"> <tt class="py-comment"># Look for response bodies in schema that contain nextPageToken, and methods</tt> </tt>
-<a name="L1096"></a><tt class="py-lineno">1096</tt> <tt class="py-line"> <tt class="py-comment"># that take a pageToken parameter.</tt> </tt>
-<a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'methods'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resourceDesc</tt><tt class="py-op">:</tt> </tt>
-<a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodDesc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">resourceDesc</tt><tt class="py-op">[</tt><tt class="py-string">'methods'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L1099"></a><tt class="py-lineno">1099</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'response'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">:</tt> </tt>
-<a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"> <tt class="py-name">responseSchema</tt> <tt class="py-op">=</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">[</tt><tt class="py-string">'response'</tt><tt class="py-op">]</tt> </tt>
-<a name="L1101"></a><tt class="py-lineno">1101</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'$ref'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">responseSchema</tt><tt class="py-op">:</tt> </tt>
-<a name="L1102"></a><tt class="py-lineno">1102</tt> <tt class="py-line"> <tt class="py-name">responseSchema</tt> <tt class="py-op">=</tt> <tt id="link-265" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-265', 'schema', 'link-42');">schema</a></tt><tt class="py-op">.</tt><tt id="link-266" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-260', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'supportsMediaDownload'</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1059"></a><tt class="py-lineno">1059</tt> <tt class="py-line"> <tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt id="link-261" class="py-name"><a title="googleapiclient.discovery.createMethod" class="py-name" href="#" onclick="return doclink('link-261', 'createMethod', 'link-257');">createMethod</a></tt><tt class="py-op">(</tt> </tt>
+<a name="L1060"></a><tt class="py-lineno">1060</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">+</tt> <tt class="py-string">'_media'</tt><tt class="py-op">,</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">,</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">,</tt> <tt id="link-262" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-262', 'schema', 'link-48');">schema</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L1061"></a><tt class="py-lineno">1061</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-263" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-263', '_set_dynamic_attr', 'link-256');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
+<a name="L1062"></a><tt class="py-lineno">1062</tt> <tt class="py-line"> <tt class="py-name">method</tt><tt class="py-op">.</tt><tt class="py-name">__get__</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L1063"></a><tt class="py-lineno">1063</tt> <tt class="py-line"> </tt>
+<a name="Resource._add_nested_resources"></a><div id="Resource._add_nested_resources-def"><a name="L1064"></a><tt class="py-lineno">1064</tt> <a class="py-toggle" href="#" id="Resource._add_nested_resources-toggle" onclick="return toggle('Resource._add_nested_resources');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#_add_nested_resources">_add_nested_resources</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-param">rootDesc</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Resource._add_nested_resources-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource._add_nested_resources-expanded"><a name="L1065"></a><tt class="py-lineno">1065</tt> <tt class="py-line"> <tt class="py-comment"># Add in nested resources</tt> </tt>
+<a name="L1066"></a><tt class="py-lineno">1066</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'resources'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resourceDesc</tt><tt class="py-op">:</tt> </tt>
+<a name="L1067"></a><tt class="py-lineno">1067</tt> <tt class="py-line"> </tt>
+<a name="L1068"></a><tt class="py-lineno">1068</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">createResourceMethod</tt><tt class="py-op">(</tt><tt class="py-param">methodName</tt><tt class="py-op">,</tt> <tt class="py-param">methodDesc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1069"></a><tt class="py-lineno">1069</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a method on the Resource to access a nested Resource.</tt> </tt>
+<a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L1071"></a><tt class="py-lineno">1071</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"><tt class="py-docstring"> methodName: string, name of the method to use.</tt> </tt>
+<a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"><tt class="py-docstring"> methodDesc: object, fragment of deserialized discovery document that</tt> </tt>
+<a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"><tt class="py-docstring"> describes the method.</tt> </tt>
+<a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"> <tt class="py-name">methodName</tt> <tt class="py-op">=</tt> <tt id="link-264" class="py-name"><a title="googleapiclient.discovery.fix_method_name" class="py-name" href="#" onclick="return doclink('link-264', 'fix_method_name', 'link-173');">fix_method_name</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">)</tt> </tt>
+<a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"> </tt>
+<a name="L1078"></a><tt class="py-lineno">1078</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">methodResource</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-265" class="py-name"><a title="googleapiclient.discovery.Resource" class="py-name" href="#" onclick="return doclink('link-265', 'Resource', 'link-122');">Resource</a></tt><tt class="py-op">(</tt><tt id="link-266" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-266', 'http', 'link-21');">http</a></tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_http</tt><tt class="py-op">,</tt> <tt class="py-name">baseUrl</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_baseUrl</tt><tt class="py-op">,</tt> </tt>
+<a name="L1080"></a><tt class="py-lineno">1080</tt> <tt class="py-line"> <tt id="link-267" class="py-name"><a title="googleapiclient.model" class="py-name" href="#" onclick="return doclink('link-267', 'model', 'link-39');">model</a></tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt><tt class="py-op">,</tt> <tt class="py-name">developerKey</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_developerKey</tt><tt class="py-op">,</tt> </tt>
+<a name="L1081"></a><tt class="py-lineno">1081</tt> <tt class="py-line"> <tt class="py-name">requestBuilder</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requestBuilder</tt><tt class="py-op">,</tt> </tt>
+<a name="L1082"></a><tt class="py-lineno">1082</tt> <tt class="py-line"> <tt class="py-name">resourceDesc</tt><tt class="py-op">=</tt><tt class="py-name">methodDesc</tt><tt class="py-op">,</tt> <tt class="py-name">rootDesc</tt><tt class="py-op">=</tt><tt class="py-name">rootDesc</tt><tt class="py-op">,</tt> </tt>
+<a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"> <tt id="link-268" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-268', 'schema', 'link-48');">schema</a></tt><tt class="py-op">=</tt><tt id="link-269" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-269', 'schema', 'link-48');">schema</a></tt><tt class="py-op">)</tt> </tt>
+</div><a name="L1084"></a><tt class="py-lineno">1084</tt> <tt class="py-line"> </tt>
+<a name="L1085"></a><tt class="py-lineno">1085</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">methodResource</tt><tt class="py-op">,</tt> <tt class="py-string">'__doc__'</tt><tt class="py-op">,</tt> <tt class="py-string">'A collection resource.'</tt><tt class="py-op">)</tt> </tt>
+<a name="L1086"></a><tt class="py-lineno">1086</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">methodResource</tt><tt class="py-op">,</tt> <tt class="py-string">'__is_resource__'</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
+<a name="L1087"></a><tt class="py-lineno">1087</tt> <tt class="py-line"> </tt>
+<a name="L1088"></a><tt class="py-lineno">1088</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodResource</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L1089"></a><tt class="py-lineno">1089</tt> <tt class="py-line"> </tt>
+<a name="L1090"></a><tt class="py-lineno">1090</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodDesc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">resourceDesc</tt><tt class="py-op">[</tt><tt class="py-string">'resources'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1091"></a><tt class="py-lineno">1091</tt> <tt class="py-line"> <tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt class="py-name">createResourceMethod</tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">)</tt> </tt>
+<a name="L1092"></a><tt class="py-lineno">1092</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-270" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-270', '_set_dynamic_attr', 'link-256');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
+<a name="L1093"></a><tt class="py-lineno">1093</tt> <tt class="py-line"> <tt class="py-name">method</tt><tt class="py-op">.</tt><tt class="py-name">__get__</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L1094"></a><tt class="py-lineno">1094</tt> <tt class="py-line"> </tt>
+<a name="Resource._add_next_methods"></a><div id="Resource._add_next_methods-def"><a name="L1095"></a><tt class="py-lineno">1095</tt> <a class="py-toggle" href="#" id="Resource._add_next_methods-toggle" onclick="return toggle('Resource._add_next_methods');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery.Resource-class.html#_add_next_methods">_add_next_methods</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">resourceDesc</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Resource._add_next_methods-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Resource._add_next_methods-expanded"><a name="L1096"></a><tt class="py-lineno">1096</tt> <tt class="py-line"> <tt class="py-comment"># Add _next() methods</tt> </tt>
+<a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"> <tt class="py-comment"># Look for response bodies in schema that contain nextPageToken, and methods</tt> </tt>
+<a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"> <tt class="py-comment"># that take a pageToken parameter.</tt> </tt>
+<a name="L1099"></a><tt class="py-lineno">1099</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'methods'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resourceDesc</tt><tt class="py-op">:</tt> </tt>
+<a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">methodName</tt><tt class="py-op">,</tt> <tt class="py-name">methodDesc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">resourceDesc</tt><tt class="py-op">[</tt><tt class="py-string">'methods'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L1101"></a><tt class="py-lineno">1101</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'response'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">:</tt> </tt>
+<a name="L1102"></a><tt class="py-lineno">1102</tt> <tt class="py-line"> <tt class="py-name">responseSchema</tt> <tt class="py-op">=</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">[</tt><tt class="py-string">'response'</tt><tt class="py-op">]</tt> </tt>
+<a name="L1103"></a><tt class="py-lineno">1103</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'$ref'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">responseSchema</tt><tt class="py-op">:</tt> </tt>
+<a name="L1104"></a><tt class="py-lineno">1104</tt> <tt class="py-line"> <tt class="py-name">responseSchema</tt> <tt class="py-op">=</tt> <tt id="link-271" class="py-name"><a title="googleapiclient.schema" class="py-name" href="#" onclick="return doclink('link-271', 'schema', 'link-48');">schema</a></tt><tt class="py-op">.</tt><tt id="link-272" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-266', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">responseSchema</tt><tt class="py-op">[</tt><tt class="py-string">'$ref'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
-<a name="L1103"></a><tt class="py-lineno">1103</tt> <tt class="py-line"> <tt class="py-name">hasNextPageToken</tt> <tt class="py-op">=</tt> <tt class="py-string">'nextPageToken'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">responseSchema</tt><tt class="py-op">.</tt><tt id="link-267" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-272', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">responseSchema</tt><tt class="py-op">[</tt><tt class="py-string">'$ref'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L1105"></a><tt class="py-lineno">1105</tt> <tt class="py-line"> <tt class="py-name">hasNextPageToken</tt> <tt class="py-op">=</tt> <tt class="py-string">'nextPageToken'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">responseSchema</tt><tt class="py-op">.</tt><tt id="link-273" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-267', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'properties'</tt><tt class="py-op">,</tt> </tt>
-<a name="L1104"></a><tt class="py-lineno">1104</tt> <tt class="py-line"> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
-<a name="L1105"></a><tt class="py-lineno">1105</tt> <tt class="py-line"> <tt class="py-name">hasPageToken</tt> <tt class="py-op">=</tt> <tt class="py-string">'pageToken'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">.</tt><tt id="link-268" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-273', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'properties'</tt><tt class="py-op">,</tt> </tt>
+<a name="L1106"></a><tt class="py-lineno">1106</tt> <tt class="py-line"> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
+<a name="L1107"></a><tt class="py-lineno">1107</tt> <tt class="py-line"> <tt class="py-name">hasPageToken</tt> <tt class="py-op">=</tt> <tt class="py-string">'pageToken'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">methodDesc</tt><tt class="py-op">.</tt><tt id="link-274" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
-googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-268', 'get', 'link-86');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'parameters'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
-<a name="L1106"></a><tt class="py-lineno">1106</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasNextPageToken</tt> <tt class="py-keyword">and</tt> <tt class="py-name">hasPageToken</tt><tt class="py-op">:</tt> </tt>
-<a name="L1107"></a><tt class="py-lineno">1107</tt> <tt class="py-line"> <tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt id="link-269" class="py-name" targets="Function googleapiclient.discovery.createNextMethod()=googleapiclient.discovery-module.html#createNextMethod"><a title="googleapiclient.discovery.createNextMethod" class="py-name" href="#" onclick="return doclink('link-269', 'createNextMethod', 'link-269');">createNextMethod</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt> <tt class="py-op">+</tt> <tt class="py-string">'_next'</tt><tt class="py-op">)</tt> </tt>
-<a name="L1108"></a><tt class="py-lineno">1108</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-270" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-270', '_set_dynamic_attr', 'link-250');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
-<a name="L1109"></a><tt class="py-lineno">1109</tt> <tt class="py-line"> <tt class="py-name">method</tt><tt class="py-op">.</tt><tt class="py-name">__get__</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-</div></div><a name="L1110"></a><tt class="py-lineno">1110</tt> <tt class="py-line"> </tt><script type="text/javascript">
+googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-274', 'get', 'link-92');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'parameters'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
+<a name="L1108"></a><tt class="py-lineno">1108</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasNextPageToken</tt> <tt class="py-keyword">and</tt> <tt class="py-name">hasPageToken</tt><tt class="py-op">:</tt> </tt>
+<a name="L1109"></a><tt class="py-lineno">1109</tt> <tt class="py-line"> <tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt id="link-275" class="py-name" targets="Function googleapiclient.discovery.createNextMethod()=googleapiclient.discovery-module.html#createNextMethod"><a title="googleapiclient.discovery.createNextMethod" class="py-name" href="#" onclick="return doclink('link-275', 'createNextMethod', 'link-275');">createNextMethod</a></tt><tt class="py-op">(</tt><tt class="py-name">methodName</tt> <tt class="py-op">+</tt> <tt class="py-string">'_next'</tt><tt class="py-op">)</tt> </tt>
+<a name="L1110"></a><tt class="py-lineno">1110</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-276" class="py-name"><a title="googleapiclient.discovery.Resource._set_dynamic_attr" class="py-name" href="#" onclick="return doclink('link-276', '_set_dynamic_attr', 'link-256');">_set_dynamic_attr</a></tt><tt class="py-op">(</tt><tt class="py-name">fixedMethodName</tt><tt class="py-op">,</tt> </tt>
+<a name="L1111"></a><tt class="py-lineno">1111</tt> <tt class="py-line"> <tt class="py-name">method</tt><tt class="py-op">.</tt><tt class="py-name">__get__</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
+</div></div><a name="L1112"></a><tt class="py-lineno">1112</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
@@ -1366,7 +1368,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery.Resource-class.html b/docs/epy/googleapiclient.discovery.Resource-class.html
index 3806052..f56ad07 100644
--- a/docs/epy/googleapiclient.discovery.Resource-class.html
+++ b/docs/epy/googleapiclient.discovery.Resource-class.html
@@ -59,10 +59,10 @@
<h1 class="epydoc">Class Resource</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_4" name="uml_class_diagram_for_googleap_4">
-<area shape="rect" id="node1_3" href="googleapiclient.discovery.Resource-class.html#__init__" title="Build a Resource from the API description." alt="" coords="18,36,611,55"/>
-<area shape="rect" id="node1_4" href="googleapiclient.discovery.Resource-class.html#__getstate__" title="Trim the state down to something that can be pickled." alt="" coords="18,55,611,73"/>
-<area shape="rect" id="node1_5" href="googleapiclient.discovery.Resource-class.html#__setstate__" title="Reconstitute the state of the object from being pickled." alt="" coords="18,73,611,92"/>
-<area shape="rect" id="node1" href="googleapiclient.discovery.Resource-class.html" title="A class for interacting with a resource." alt="" coords="5,5,623,99"/>
+<area shape="rect" id="node1_3" href="googleapiclient.discovery.Resource-class.html#__init__" title="Build a Resource from the API description." alt="" coords="16,40,605,60"/>
+<area shape="rect" id="node1_4" href="googleapiclient.discovery.Resource-class.html#__getstate__" title="Trim the state down to something that can be pickled." alt="" coords="16,60,605,80"/>
+<area shape="rect" id="node1_5" href="googleapiclient.discovery.Resource-class.html#__setstate__" title="Reconstitute the state of the object from being pickled." alt="" coords="16,80,605,100"/>
+<area shape="rect" id="node1" href="googleapiclient.discovery.Resource-class.html" title="A class for interacting with a resource." alt="" coords="4,6,617,106"/>
</map>
<img src="uml_class_diagram_for_googleap_4.gif" alt='' usemap="#uml_class_diagram_for_googleap_4" ismap="ismap" class="graph-without-title" />
</center>
@@ -458,7 +458,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html b/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html
index 79497aa..da22d0a 100644
--- a/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html
+++ b/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html
@@ -59,9 +59,9 @@
<h1 class="epydoc">Class ResourceMethodParameters</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#ResourceMethodParameters">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_5" name="uml_class_diagram_for_googleap_5">
-<area shape="rect" id="node1_2" href="googleapiclient.discovery.ResourceMethodParameters-class.html#__init__" title="Constructor for ResourceMethodParameters." alt="" coords="18,36,233,55"/>
-<area shape="rect" id="node1_3" href="googleapiclient.discovery.ResourceMethodParameters-class.html#set_parameters" title="Populates maps and lists based on method description." alt="" coords="18,55,233,73"/>
-<area shape="rect" id="node1" href="googleapiclient.discovery.ResourceMethodParameters-class.html" title="Represents the parameters associated with a method." alt="" coords="5,5,244,80"/>
+<area shape="rect" id="node1_2" href="googleapiclient.discovery.ResourceMethodParameters-class.html#__init__" title="Constructor for ResourceMethodParameters." alt="" coords="17,39,229,59"/>
+<area shape="rect" id="node1_3" href="googleapiclient.discovery.ResourceMethodParameters-class.html#set_parameters" title="Populates maps and lists based on method description." alt="" coords="17,59,229,79"/>
+<area shape="rect" id="node1" href="googleapiclient.discovery.ResourceMethodParameters-class.html" title="Represents the parameters associated with a method." alt="" coords="5,5,241,85"/>
</map>
<img src="uml_class_diagram_for_googleap_5.gif" alt='' usemap="#uml_class_diagram_for_googleap_5" ismap="ismap" class="graph-without-title" />
</center>
@@ -300,7 +300,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery._BytesGenerator-class.html b/docs/epy/googleapiclient.discovery._BytesGenerator-class.html
index 1cc7ae4..016be45 100644
--- a/docs/epy/googleapiclient.discovery._BytesGenerator-class.html
+++ b/docs/epy/googleapiclient.discovery._BytesGenerator-class.html
@@ -59,7 +59,7 @@
<h1 class="epydoc">Class _BytesGenerator</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_BytesGenerator">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_6" name="uml_class_diagram_for_googleap_6">
-<area shape="rect" id="node1" href="googleapiclient.discovery._BytesGenerator-class.html" title="googleapiclient.discovery._BytesGenerator" alt="" coords="5,5,129,48"/>
+<area shape="rect" id="node1" href="googleapiclient.discovery._BytesGenerator-class.html" title="googleapiclient.discovery._BytesGenerator" alt="" coords="5,5,129,51"/>
</map>
<img src="uml_class_diagram_for_googleap_6.gif" alt='' usemap="#uml_class_diagram_for_googleap_6" ismap="ismap" class="graph-without-title" />
</center>
@@ -116,7 +116,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache-module.html b/docs/epy/googleapiclient.discovery_cache-module.html
index e7cc9c3..ed6127f 100644
--- a/docs/epy/googleapiclient.discovery_cache-module.html
+++ b/docs/epy/googleapiclient.discovery_cache-module.html
@@ -225,7 +225,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache-pysrc.html b/docs/epy/googleapiclient.discovery_cache-pysrc.html
index ba12b8e..223d59b 100644
--- a/docs/epy/googleapiclient.discovery_cache-pysrc.html
+++ b/docs/epy/googleapiclient.discovery_cache-pysrc.html
@@ -144,7 +144,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.appengine_memcache-module.html b/docs/epy/googleapiclient.discovery_cache.appengine_memcache-module.html
index e88659d..1f1b735 100644
--- a/docs/epy/googleapiclient.discovery_cache.appengine_memcache-module.html
+++ b/docs/epy/googleapiclient.discovery_cache.appengine_memcache-module.html
@@ -153,7 +153,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.appengine_memcache-pysrc.html b/docs/epy/googleapiclient.discovery_cache.appengine_memcache-pysrc.html
index dd8cd9c..4e60156 100644
--- a/docs/epy/googleapiclient.discovery_cache.appengine_memcache-pysrc.html
+++ b/docs/epy/googleapiclient.discovery_cache.appengine_memcache-pysrc.html
@@ -165,7 +165,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.appengine_memcache.Cache-class.html b/docs/epy/googleapiclient.discovery_cache.appengine_memcache.Cache-class.html
index 617074e..7f78287 100644
--- a/docs/epy/googleapiclient.discovery_cache.appengine_memcache.Cache-class.html
+++ b/docs/epy/googleapiclient.discovery_cache.appengine_memcache.Cache-class.html
@@ -60,12 +60,12 @@
<h1 class="epydoc">Class Cache</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery_cache.appengine_memcache-pysrc.html#Cache">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_7" name="uml_class_diagram_for_googleap_7">
-<area shape="rect" id="node1_4" href="googleapiclient.discovery_cache.appengine_memcache.Cache-class.html#__init__" title="Constructor." alt="" coords="18,111,161,129"/>
-<area shape="rect" id="node1_5" href="googleapiclient.discovery_cache.appengine_memcache.Cache-class.html#get" title="Gets the content from the memcache with a given key." alt="" coords="18,129,161,148"/>
-<area shape="rect" id="node1_6" href="googleapiclient.discovery_cache.appengine_memcache.Cache-class.html#set" title="Sets the given key and content in the cache." alt="" coords="18,148,161,167"/>
-<area shape="rect" id="node1" href="googleapiclient.discovery_cache.appengine_memcache.Cache-class.html" title="A cache with app engine memcache API." alt="" coords="5,80,172,173"/>
-<area shape="rect" id="node2_7" href="googleapiclient.discovery_cache.base.Cache-class.html#__metaclass__" title="googleapiclient.discovery_cache.base.Cache.__metaclass__" alt="" coords="42,28,137,47"/>
-<area shape="rect" id="node2" href="googleapiclient.discovery_cache.base.Cache-class.html" title="A base abstract cache class." alt="" coords="29,5,148,61"/>
+<area shape="rect" id="node1_4" href="googleapiclient.discovery_cache.appengine_memcache.Cache-class.html#__init__" title="Constructor." alt="" coords="17,120,160,140"/>
+<area shape="rect" id="node1_5" href="googleapiclient.discovery_cache.appengine_memcache.Cache-class.html#get" title="Gets the content from the memcache with a given key." alt="" coords="17,140,160,160"/>
+<area shape="rect" id="node1_6" href="googleapiclient.discovery_cache.appengine_memcache.Cache-class.html#set" title="Sets the given key and content in the cache." alt="" coords="17,160,160,180"/>
+<area shape="rect" id="node1" href="googleapiclient.discovery_cache.appengine_memcache.Cache-class.html" title="A cache with app engine memcache API." alt="" coords="5,86,171,186"/>
+<area shape="rect" id="node2_7" href="googleapiclient.discovery_cache.base.Cache-class.html#__metaclass__" title="googleapiclient.discovery_cache.base.Cache.__metaclass__" alt="" coords="41,32,137,52"/>
+<area shape="rect" id="node2" href="googleapiclient.discovery_cache.base.Cache-class.html" title="A base abstract cache class." alt="" coords="29,6,149,66"/>
</map>
<img src="uml_class_diagram_for_googleap_7.gif" alt='' usemap="#uml_class_diagram_for_googleap_7" ismap="ismap" class="graph-without-title" />
</center>
@@ -358,7 +358,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.base-module.html b/docs/epy/googleapiclient.discovery_cache.base-module.html
index e449612..5f11876 100644
--- a/docs/epy/googleapiclient.discovery_cache.base-module.html
+++ b/docs/epy/googleapiclient.discovery_cache.base-module.html
@@ -114,7 +114,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.base-pysrc.html b/docs/epy/googleapiclient.discovery_cache.base-pysrc.html
index 08c8e72..fea25ad 100644
--- a/docs/epy/googleapiclient.discovery_cache.base-pysrc.html
+++ b/docs/epy/googleapiclient.discovery_cache.base-pysrc.html
@@ -135,7 +135,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.base.Cache-class.html b/docs/epy/googleapiclient.discovery_cache.base.Cache-class.html
index 67ac4a8..39cf8da 100644
--- a/docs/epy/googleapiclient.discovery_cache.base.Cache-class.html
+++ b/docs/epy/googleapiclient.discovery_cache.base.Cache-class.html
@@ -60,10 +60,10 @@
<h1 class="epydoc">Class Cache</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery_cache.base-pysrc.html#Cache">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_8" name="uml_class_diagram_for_googleap_8">
-<area shape="rect" id="node1_3" href="googleapiclient.discovery_cache.base.Cache-class.html#__metaclass__" title="googleapiclient.discovery_cache.base.Cache.__metaclass__" alt="" coords="17,28,143,47"/>
-<area shape="rect" id="node1_4" href="googleapiclient.discovery_cache.base.Cache-class.html#get" title="Gets the content from the memcache with a given key." alt="" coords="17,49,143,68"/>
-<area shape="rect" id="node1_5" href="googleapiclient.discovery_cache.base.Cache-class.html#set" title="Sets the given key and content in the cache." alt="" coords="17,68,143,87"/>
-<area shape="rect" id="node1" href="googleapiclient.discovery_cache.base.Cache-class.html" title="A base abstract cache class." alt="" coords="5,5,155,93"/>
+<area shape="rect" id="node1_3" href="googleapiclient.discovery_cache.base.Cache-class.html#__metaclass__" title="googleapiclient.discovery_cache.base.Cache.__metaclass__" alt="" coords="17,32,145,52"/>
+<area shape="rect" id="node1_4" href="googleapiclient.discovery_cache.base.Cache-class.html#get" title="Gets the content from the memcache with a given key." alt="" coords="17,55,145,75"/>
+<area shape="rect" id="node1_5" href="googleapiclient.discovery_cache.base.Cache-class.html#set" title="Sets the given key and content in the cache." alt="" coords="17,75,145,95"/>
+<area shape="rect" id="node1" href="googleapiclient.discovery_cache.base.Cache-class.html" title="A base abstract cache class." alt="" coords="5,6,157,101"/>
</map>
<img src="uml_class_diagram_for_googleap_8.gif" alt='' usemap="#uml_class_diagram_for_googleap_8" ismap="ismap" class="graph-without-title" />
</center>
@@ -309,7 +309,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.file_cache-module.html b/docs/epy/googleapiclient.discovery_cache.file_cache-module.html
index 2361be2..446394e 100644
--- a/docs/epy/googleapiclient.discovery_cache.file_cache-module.html
+++ b/docs/epy/googleapiclient.discovery_cache.file_cache-module.html
@@ -215,7 +215,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.file_cache-pysrc.html b/docs/epy/googleapiclient.discovery_cache.file_cache-pysrc.html
index a106e53..1aedb0b 100644
--- a/docs/epy/googleapiclient.discovery_cache.file_cache-pysrc.html
+++ b/docs/epy/googleapiclient.discovery_cache.file_cache-pysrc.html
@@ -92,153 +92,158 @@
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">contrib</tt><tt class="py-op">.</tt><tt class="py-name">locked_file</tt> <tt class="py-keyword">import</tt> <tt class="py-name">LockedFile</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"> <tt class="py-comment"># oauth2client < 2.0.0</tt> </tt>
-<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">locked_file</tt> <tt class="py-keyword">import</tt> <tt class="py-name">LockedFile</tt> </tt>
-<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"> </tt>
-<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-op">.</tt> <tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Module googleapiclient.discovery_cache.base=googleapiclient.discovery_cache.base-module.html"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-0', 'base', 'link-0');">base</a></tt> </tt>
-<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-op">.</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Package googleapiclient.discovery_cache=googleapiclient.discovery_cache-module.html"><a title="googleapiclient.discovery_cache" class="py-name" href="#" onclick="return doclink('link-1', 'discovery_cache', 'link-1');">discovery_cache</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Variable googleapiclient.discovery_cache.DISCOVERY_DOC_MAX_AGE=googleapiclient.discovery_cache-module.html#DISCOVERY_DOC_MAX_AGE"><a title="googleapiclient.discovery_cache.DISCOVERY_DOC_MAX_AGE" class="py-name" href="#" onclick="return doclink('link-2', 'DISCOVERY_DOC_MAX_AGE', 'link-2');">DISCOVERY_DOC_MAX_AGE</a></tt> </tt>
-<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> </tt>
-<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt id="link-3" class="py-name" targets="Variable googleapiclient.discovery_cache.LOGGER=googleapiclient.discovery_cache-module.html#LOGGER,Variable googleapiclient.discovery_cache.appengine_memcache.LOGGER=googleapiclient.discovery_cache.appengine_memcache-module.html#LOGGER,Variable googleapiclient.discovery_cache.file_cache.LOGGER=googleapiclient.discovery_cache.file_cache-module.html#LOGGER,Variable googleapiclient.http.LOGGER=googleapiclient.http-module.html#LOGGER,Variable googleapiclient.model.LOGGER=googleapiclient.model-module.html#LOGGER"><a title="googleapiclient.discovery_cache.LOGGER
+<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
+<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">locked_file</tt> <tt class="py-keyword">import</tt> <tt class="py-name">LockedFile</tt> </tt>
+<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt>
+<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-comment"># oauth2client > 4.0.0</tt> </tt>
+<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">(</tt> </tt>
+<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"> <tt class="py-string">'file_cache is unavailable when using oauth2client >= 4.0.0'</tt><tt class="py-op">)</tt> </tt>
+<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> </tt>
+<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-op">.</tt> <tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Module googleapiclient.discovery_cache.base=googleapiclient.discovery_cache.base-module.html"><a title="googleapiclient.discovery_cache.base" class="py-name" href="#" onclick="return doclink('link-0', 'base', 'link-0');">base</a></tt> </tt>
+<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-op">.</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Package googleapiclient.discovery_cache=googleapiclient.discovery_cache-module.html"><a title="googleapiclient.discovery_cache" class="py-name" href="#" onclick="return doclink('link-1', 'discovery_cache', 'link-1');">discovery_cache</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Variable googleapiclient.discovery_cache.DISCOVERY_DOC_MAX_AGE=googleapiclient.discovery_cache-module.html#DISCOVERY_DOC_MAX_AGE"><a title="googleapiclient.discovery_cache.DISCOVERY_DOC_MAX_AGE" class="py-name" href="#" onclick="return doclink('link-2', 'DISCOVERY_DOC_MAX_AGE', 'link-2');">DISCOVERY_DOC_MAX_AGE</a></tt> </tt>
+<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> </tt>
+<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt id="link-3" class="py-name" targets="Variable googleapiclient.discovery_cache.LOGGER=googleapiclient.discovery_cache-module.html#LOGGER,Variable googleapiclient.discovery_cache.appengine_memcache.LOGGER=googleapiclient.discovery_cache.appengine_memcache-module.html#LOGGER,Variable googleapiclient.discovery_cache.file_cache.LOGGER=googleapiclient.discovery_cache.file_cache-module.html#LOGGER,Variable googleapiclient.http.LOGGER=googleapiclient.http-module.html#LOGGER,Variable googleapiclient.model.LOGGER=googleapiclient.model-module.html#LOGGER"><a title="googleapiclient.discovery_cache.LOGGER
googleapiclient.discovery_cache.appengine_memcache.LOGGER
googleapiclient.discovery_cache.file_cache.LOGGER
googleapiclient.http.LOGGER
googleapiclient.model.LOGGER" class="py-name" href="#" onclick="return doclink('link-3', 'LOGGER', 'link-3');">LOGGER</a></tt> <tt class="py-op">=</tt> <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">getLogger</tt><tt class="py-op">(</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt> </tt>
-<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> </tt>
-<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt id="link-4" class="py-name" targets="Variable googleapiclient.discovery_cache.file_cache.FILENAME=googleapiclient.discovery_cache.file_cache-module.html#FILENAME"><a title="googleapiclient.discovery_cache.file_cache.FILENAME" class="py-name" href="#" onclick="return doclink('link-4', 'FILENAME', 'link-4');">FILENAME</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'google-api-python-client-discovery-doc.cache'</tt> </tt>
-<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt id="link-5" class="py-name" targets="Variable googleapiclient.channel.EPOCH=googleapiclient.channel-module.html#EPOCH,Variable googleapiclient.discovery_cache.file_cache.EPOCH=googleapiclient.discovery_cache.file_cache-module.html#EPOCH"><a title="googleapiclient.channel.EPOCH
+<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> </tt>
+<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt id="link-4" class="py-name" targets="Variable googleapiclient.discovery_cache.file_cache.FILENAME=googleapiclient.discovery_cache.file_cache-module.html#FILENAME"><a title="googleapiclient.discovery_cache.file_cache.FILENAME" class="py-name" href="#" onclick="return doclink('link-4', 'FILENAME', 'link-4');">FILENAME</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'google-api-python-client-discovery-doc.cache'</tt> </tt>
+<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt id="link-5" class="py-name" targets="Variable googleapiclient.channel.EPOCH=googleapiclient.channel-module.html#EPOCH,Variable googleapiclient.discovery_cache.file_cache.EPOCH=googleapiclient.discovery_cache.file_cache-module.html#EPOCH"><a title="googleapiclient.channel.EPOCH
googleapiclient.discovery_cache.file_cache.EPOCH" class="py-name" href="#" onclick="return doclink('link-5', 'EPOCH', 'link-5');">EPOCH</a></tt> <tt class="py-op">=</tt> <tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">utcfromtimestamp</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
-<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> </tt>
-<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> </tt>
-<a name="_to_timestamp"></a><div id="_to_timestamp-def"><a name="L47"></a><tt class="py-lineno"> 47</tt> <a class="py-toggle" href="#" id="_to_timestamp-toggle" onclick="return toggle('_to_timestamp');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.file_cache-module.html#_to_timestamp">_to_timestamp</a><tt class="py-op">(</tt><tt class="py-param">date</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="_to_timestamp-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_to_timestamp-expanded"><a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
-<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">date</tt> <tt class="py-op">-</tt> <tt id="link-6" class="py-name"><a title="googleapiclient.channel.EPOCH
+<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> </tt>
+<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> </tt>
+<a name="_to_timestamp"></a><div id="_to_timestamp-def"><a name="L52"></a><tt class="py-lineno"> 52</tt> <a class="py-toggle" href="#" id="_to_timestamp-toggle" onclick="return toggle('_to_timestamp');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.file_cache-module.html#_to_timestamp">_to_timestamp</a><tt class="py-op">(</tt><tt class="py-param">date</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="_to_timestamp-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_to_timestamp-expanded"><a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
+<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">date</tt> <tt class="py-op">-</tt> <tt id="link-6" class="py-name"><a title="googleapiclient.channel.EPOCH
googleapiclient.discovery_cache.file_cache.EPOCH" class="py-name" href="#" onclick="return doclink('link-6', 'EPOCH', 'link-5');">EPOCH</a></tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">total_seconds</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
-<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> <tt class="py-comment"># The following is the equivalent of total_seconds() in Python2.6.</tt> </tt>
-<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"> <tt class="py-comment"># See also: https://docs.python.org/2/library/datetime.html</tt> </tt>
-<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> <tt class="py-name">delta</tt> <tt class="py-op">=</tt> <tt class="py-name">date</tt> <tt class="py-op">-</tt> <tt id="link-7" class="py-name"><a title="googleapiclient.channel.EPOCH
+<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
+<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> <tt class="py-comment"># The following is the equivalent of total_seconds() in Python2.6.</tt> </tt>
+<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> <tt class="py-comment"># See also: https://docs.python.org/2/library/datetime.html</tt> </tt>
+<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"> <tt class="py-name">delta</tt> <tt class="py-op">=</tt> <tt class="py-name">date</tt> <tt class="py-op">-</tt> <tt id="link-7" class="py-name"><a title="googleapiclient.channel.EPOCH
googleapiclient.discovery_cache.file_cache.EPOCH" class="py-name" href="#" onclick="return doclink('link-7', 'EPOCH', 'link-5');">EPOCH</a></tt> </tt>
-<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">delta</tt><tt class="py-op">.</tt><tt class="py-name">microseconds</tt> <tt class="py-op">+</tt> <tt class="py-op">(</tt><tt class="py-name">delta</tt><tt class="py-op">.</tt><tt class="py-name">seconds</tt> <tt class="py-op">+</tt> <tt class="py-name">delta</tt><tt class="py-op">.</tt><tt class="py-name">days</tt> <tt class="py-op">*</tt> <tt class="py-number">24</tt> <tt class="py-op">*</tt> <tt class="py-number">3600</tt><tt class="py-op">)</tt> </tt>
-<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> <tt class="py-op">*</tt> <tt class="py-number">10</tt><tt class="py-op">**</tt><tt class="py-number">6</tt><tt class="py-op">)</tt> <tt class="py-op">/</tt> <tt class="py-number">10</tt><tt class="py-op">**</tt><tt class="py-number">6</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> </tt>
-<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> </tt>
-<a name="_read_or_initialize_cache"></a><div id="_read_or_initialize_cache-def"><a name="L58"></a><tt class="py-lineno"> 58</tt> <a class="py-toggle" href="#" id="_read_or_initialize_cache-toggle" onclick="return toggle('_read_or_initialize_cache');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.file_cache-module.html#_read_or_initialize_cache">_read_or_initialize_cache</a><tt class="py-op">(</tt><tt class="py-param">f</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="_read_or_initialize_cache-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_read_or_initialize_cache-expanded"><a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">seek</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
-<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
-<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> <tt id="link-8" class="py-name" targets="Variable googleapiclient.discovery_cache.appengine_memcache.cache=googleapiclient.discovery_cache.appengine_memcache-module.html#cache,Variable googleapiclient.discovery_cache.file_cache.cache=googleapiclient.discovery_cache.file_cache-module.html#cache"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">delta</tt><tt class="py-op">.</tt><tt class="py-name">microseconds</tt> <tt class="py-op">+</tt> <tt class="py-op">(</tt><tt class="py-name">delta</tt><tt class="py-op">.</tt><tt class="py-name">seconds</tt> <tt class="py-op">+</tt> <tt class="py-name">delta</tt><tt class="py-op">.</tt><tt class="py-name">days</tt> <tt class="py-op">*</tt> <tt class="py-number">24</tt> <tt class="py-op">*</tt> <tt class="py-number">3600</tt><tt class="py-op">)</tt> </tt>
+<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"> <tt class="py-op">*</tt> <tt class="py-number">10</tt><tt class="py-op">**</tt><tt class="py-number">6</tt><tt class="py-op">)</tt> <tt class="py-op">/</tt> <tt class="py-number">10</tt><tt class="py-op">**</tt><tt class="py-number">6</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> </tt>
+<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"> </tt>
+<a name="_read_or_initialize_cache"></a><div id="_read_or_initialize_cache-def"><a name="L63"></a><tt class="py-lineno"> 63</tt> <a class="py-toggle" href="#" id="_read_or_initialize_cache-toggle" onclick="return toggle('_read_or_initialize_cache');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.file_cache-module.html#_read_or_initialize_cache">_read_or_initialize_cache</a><tt class="py-op">(</tt><tt class="py-param">f</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="_read_or_initialize_cache-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_read_or_initialize_cache-expanded"><a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">seek</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
+<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
+<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> <tt id="link-8" class="py-name" targets="Variable googleapiclient.discovery_cache.appengine_memcache.cache=googleapiclient.discovery_cache.appengine_memcache-module.html#cache,Variable googleapiclient.discovery_cache.file_cache.cache=googleapiclient.discovery_cache.file_cache-module.html#cache"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-8', 'cache', 'link-8');">cache</a></tt> <tt class="py-op">=</tt> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">load</tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">:</tt> </tt>
-<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> <tt class="py-comment"># This means it opens the file for the first time, or the cache is</tt> </tt>
-<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt class="py-comment"># corrupted, so initializing the file with an empty dict.</tt> </tt>
-<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt id="link-9" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">:</tt> </tt>
+<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt class="py-comment"># This means it opens the file for the first time, or the cache is</tt> </tt>
+<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-comment"># corrupted, so initializing the file with an empty dict.</tt> </tt>
+<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> <tt id="link-9" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-9', 'cache', 'link-8');">cache</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
-<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">truncate</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
-<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">seek</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
-<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">dump</tt><tt class="py-op">(</tt><tt id="link-10" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">truncate</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
+<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">seek</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
+<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">dump</tt><tt class="py-op">(</tt><tt id="link-10" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-10', 'cache', 'link-8');">cache</a></tt><tt class="py-op">,</tt> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-11" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-11" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-11', 'cache', 'link-8');">cache</a></tt> </tt>
-</div><a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> </tt>
-<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> </tt>
-<a name="Cache"></a><div id="Cache-def"><a name="L72"></a><tt class="py-lineno"> 72</tt> <a class="py-toggle" href="#" id="Cache-toggle" onclick="return toggle('Cache');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.file_cache.Cache-class.html">Cache</a><tt class="py-op">(</tt><tt class="py-base-class">base</tt><tt class="py-op">.</tt><tt class="py-base-class">Cache</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Cache-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Cache-expanded"><a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-docstring">"""A file based cache for the discovery documents."""</tt> </tt>
-<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> </tt>
-<a name="Cache.__init__"></a><div id="Cache.__init__-def"><a name="L75"></a><tt class="py-lineno"> 75</tt> <a class="py-toggle" href="#" id="Cache.__init__-toggle" onclick="return toggle('Cache.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.file_cache.Cache-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">max_age</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Cache.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Cache.__init__-expanded"><a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
-<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
-<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
-<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> max_age: Cache expiration in seconds.</tt> </tt>
-<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
-<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_max_age</tt> <tt class="py-op">=</tt> <tt class="py-name">max_age</tt> </tt>
-<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">tempfile</tt><tt class="py-op">.</tt><tt class="py-name">gettempdir</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-12" class="py-name"><a title="googleapiclient.discovery_cache.file_cache.FILENAME" class="py-name" href="#" onclick="return doclink('link-12', 'FILENAME', 'link-4');">FILENAME</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt class="py-name">LockedFile</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">,</tt> <tt class="py-string">'a+'</tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">)</tt> </tt>
-<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
-<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">open_and_lock</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">is_locked</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt id="link-13" class="py-name" targets="Function googleapiclient.discovery_cache.file_cache._read_or_initialize_cache()=googleapiclient.discovery_cache.file_cache-module.html#_read_or_initialize_cache"><a title="googleapiclient.discovery_cache.file_cache._read_or_initialize_cache" class="py-name" href="#" onclick="return doclink('link-13', '_read_or_initialize_cache', 'link-13');">_read_or_initialize_cache</a></tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt> </tt>
-<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> <tt class="py-comment"># If we can not obtain the lock, other process or thread must</tt> </tt>
-<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-comment"># have initialized the file.</tt> </tt>
-<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt> <tt class="py-keyword">as</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
-<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt id="link-14" class="py-name"><a title="googleapiclient.discovery_cache.LOGGER
+</div><a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> </tt>
+<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> </tt>
+<a name="Cache"></a><div id="Cache-def"><a name="L77"></a><tt class="py-lineno"> 77</tt> <a class="py-toggle" href="#" id="Cache-toggle" onclick="return toggle('Cache');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.file_cache.Cache-class.html">Cache</a><tt class="py-op">(</tt><tt class="py-base-class">base</tt><tt class="py-op">.</tt><tt class="py-base-class">Cache</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Cache-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Cache-expanded"><a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> <tt class="py-docstring">"""A file based cache for the discovery documents."""</tt> </tt>
+<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> </tt>
+<a name="Cache.__init__"></a><div id="Cache.__init__-def"><a name="L80"></a><tt class="py-lineno"> 80</tt> <a class="py-toggle" href="#" id="Cache.__init__-toggle" onclick="return toggle('Cache.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.file_cache.Cache-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">max_age</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Cache.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Cache.__init__-expanded"><a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
+<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
+<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
+<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"> max_age: Cache expiration in seconds.</tt> </tt>
+<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
+<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_max_age</tt> <tt class="py-op">=</tt> <tt class="py-name">max_age</tt> </tt>
+<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">tempfile</tt><tt class="py-op">.</tt><tt class="py-name">gettempdir</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-12" class="py-name"><a title="googleapiclient.discovery_cache.file_cache.FILENAME" class="py-name" href="#" onclick="return doclink('link-12', 'FILENAME', 'link-4');">FILENAME</a></tt><tt class="py-op">)</tt> </tt>
+<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt class="py-name">LockedFile</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">,</tt> <tt class="py-string">'a+'</tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">)</tt> </tt>
+<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
+<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">open_and_lock</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">is_locked</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt id="link-13" class="py-name" targets="Function googleapiclient.discovery_cache.file_cache._read_or_initialize_cache()=googleapiclient.discovery_cache.file_cache-module.html#_read_or_initialize_cache"><a title="googleapiclient.discovery_cache.file_cache._read_or_initialize_cache" class="py-name" href="#" onclick="return doclink('link-13', '_read_or_initialize_cache', 'link-13');">_read_or_initialize_cache</a></tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt> </tt>
+<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-comment"># If we can not obtain the lock, other process or thread must</tt> </tt>
+<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-comment"># have initialized the file.</tt> </tt>
+<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt> <tt class="py-keyword">as</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
+<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt id="link-14" class="py-name"><a title="googleapiclient.discovery_cache.LOGGER
googleapiclient.discovery_cache.appengine_memcache.LOGGER
googleapiclient.discovery_cache.file_cache.LOGGER
googleapiclient.http.LOGGER
googleapiclient.model.LOGGER" class="py-name" href="#" onclick="return doclink('link-14', 'LOGGER', 'link-3');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">warning</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">,</tt> <tt class="py-name">exc_info</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
-<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
-<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">unlock_and_close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> </tt>
-<a name="Cache.get"></a><div id="Cache.get-def"><a name="L95"></a><tt class="py-lineno"> 95</tt> <a class="py-toggle" href="#" id="Cache.get-toggle" onclick="return toggle('Cache.get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.file_cache.Cache-class.html#get">get</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Cache.get-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Cache.get-expanded"><a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt class="py-name">LockedFile</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">,</tt> <tt class="py-string">'r+'</tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">)</tt> </tt>
-<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
-<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">open_and_lock</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">is_locked</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> <tt id="link-15" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
+<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">unlock_and_close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> </tt>
+<a name="Cache.get"></a><div id="Cache.get-def"><a name="L100"></a><tt class="py-lineno">100</tt> <a class="py-toggle" href="#" id="Cache.get-toggle" onclick="return toggle('Cache.get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.file_cache.Cache-class.html#get">get</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Cache.get-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Cache.get-expanded"><a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt class="py-name">LockedFile</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">,</tt> <tt class="py-string">'r+'</tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">)</tt> </tt>
+<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
+<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">open_and_lock</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">is_locked</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt id="link-15" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-15', 'cache', 'link-8');">cache</a></tt> <tt class="py-op">=</tt> <tt id="link-16" class="py-name"><a title="googleapiclient.discovery_cache.file_cache._read_or_initialize_cache" class="py-name" href="#" onclick="return doclink('link-16', '_read_or_initialize_cache', 'link-13');">_read_or_initialize_cache</a></tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt> </tt>
-<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">url</tt> <tt class="py-keyword">in</tt> <tt id="link-17" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">url</tt> <tt class="py-keyword">in</tt> <tt id="link-17" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-17', 'cache', 'link-8');">cache</a></tt><tt class="py-op">:</tt> </tt>
-<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> <tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">t</tt> <tt class="py-op">=</tt> <tt id="link-18" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> <tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">t</tt> <tt class="py-op">=</tt> <tt id="link-18" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-18', 'cache', 'link-8');">cache</a></tt><tt class="py-op">.</tt><tt id="link-19" class="py-name" targets="Method googleapiclient.discovery_cache.appengine_memcache.Cache.get()=googleapiclient.discovery_cache.appengine_memcache.Cache-class.html#get,Method googleapiclient.discovery_cache.base.Cache.get()=googleapiclient.discovery_cache.base.Cache-class.html#get,Method googleapiclient.discovery_cache.file_cache.Cache.get()=googleapiclient.discovery_cache.file_cache.Cache-class.html#get,Method googleapiclient.schema.Schemas.get()=googleapiclient.schema.Schemas-class.html#get"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache.get
googleapiclient.discovery_cache.base.Cache.get
googleapiclient.discovery_cache.file_cache.Cache.get
googleapiclient.schema.Schemas.get" class="py-name" href="#" onclick="return doclink('link-19', 'get', 'link-19');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-20" class="py-name" targets="Function googleapiclient.discovery_cache.file_cache._to_timestamp()=googleapiclient.discovery_cache.file_cache-module.html#_to_timestamp"><a title="googleapiclient.discovery_cache.file_cache._to_timestamp" class="py-name" href="#" onclick="return doclink('link-20', '_to_timestamp', 'link-20');">_to_timestamp</a></tt><tt class="py-op">(</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">now</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op"><</tt> <tt class="py-name">t</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_max_age</tt><tt class="py-op">:</tt> </tt>
-<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">content</tt> </tt>
-<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
-<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> <tt id="link-21" class="py-name"><a title="googleapiclient.discovery_cache.LOGGER
+<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-20" class="py-name" targets="Function googleapiclient.discovery_cache.file_cache._to_timestamp()=googleapiclient.discovery_cache.file_cache-module.html#_to_timestamp"><a title="googleapiclient.discovery_cache.file_cache._to_timestamp" class="py-name" href="#" onclick="return doclink('link-20', '_to_timestamp', 'link-20');">_to_timestamp</a></tt><tt class="py-op">(</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">now</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op"><</tt> <tt class="py-name">t</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_max_age</tt><tt class="py-op">:</tt> </tt>
+<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">content</tt> </tt>
+<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
+<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"> <tt id="link-21" class="py-name"><a title="googleapiclient.discovery_cache.LOGGER
googleapiclient.discovery_cache.appengine_memcache.LOGGER
googleapiclient.discovery_cache.file_cache.LOGGER
googleapiclient.http.LOGGER
googleapiclient.model.LOGGER" class="py-name" href="#" onclick="return doclink('link-21', 'LOGGER', 'link-3');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">'Could not obtain a lock for the cache file.'</tt><tt class="py-op">)</tt> </tt>
-<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
-<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt> <tt class="py-keyword">as</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
-<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"> <tt id="link-22" class="py-name"><a title="googleapiclient.discovery_cache.LOGGER
+<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
+<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt> <tt class="py-keyword">as</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
+<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> <tt id="link-22" class="py-name"><a title="googleapiclient.discovery_cache.LOGGER
googleapiclient.discovery_cache.appengine_memcache.LOGGER
googleapiclient.discovery_cache.file_cache.LOGGER
googleapiclient.http.LOGGER
googleapiclient.model.LOGGER" class="py-name" href="#" onclick="return doclink('link-22', 'LOGGER', 'link-3');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">warning</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">,</tt> <tt class="py-name">exc_info</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
-<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
-<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">unlock_and_close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-</div><a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"> </tt>
-<a name="Cache.set"></a><div id="Cache.set-def"><a name="L114"></a><tt class="py-lineno">114</tt> <a class="py-toggle" href="#" id="Cache.set-toggle" onclick="return toggle('Cache.set');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.file_cache.Cache-class.html#set">set</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-</div><div id="Cache.set-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Cache.set-expanded"><a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt class="py-name">LockedFile</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">,</tt> <tt class="py-string">'r+'</tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">)</tt> </tt>
-<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
-<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">open_and_lock</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">is_locked</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"> <tt id="link-23" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
+<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">unlock_and_close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+</div><a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"> </tt>
+<a name="Cache.set"></a><div id="Cache.set-def"><a name="L119"></a><tt class="py-lineno">119</tt> <a class="py-toggle" href="#" id="Cache.set-toggle" onclick="return toggle('Cache.set');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.file_cache.Cache-class.html#set">set</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="Cache.set-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Cache.set-expanded"><a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt class="py-name">LockedFile</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">,</tt> <tt class="py-string">'r+'</tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">)</tt> </tt>
+<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
+<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">open_and_lock</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">is_locked</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> <tt id="link-23" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-23', 'cache', 'link-8');">cache</a></tt> <tt class="py-op">=</tt> <tt id="link-24" class="py-name"><a title="googleapiclient.discovery_cache.file_cache._read_or_initialize_cache" class="py-name" href="#" onclick="return doclink('link-24', '_read_or_initialize_cache', 'link-13');">_read_or_initialize_cache</a></tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">)</tt> </tt>
-<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"> <tt id="link-25" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt id="link-25" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-25', 'cache', 'link-8');">cache</a></tt><tt class="py-op">[</tt><tt class="py-name">url</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">,</tt> <tt id="link-26" class="py-name"><a title="googleapiclient.discovery_cache.file_cache._to_timestamp" class="py-name" href="#" onclick="return doclink('link-26', '_to_timestamp', 'link-20');">_to_timestamp</a></tt><tt class="py-op">(</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">now</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"> <tt class="py-comment"># Remove stale cache.</tt> </tt>
-<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">k</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">_</tt><tt class="py-op">,</tt> <tt class="py-name">timestamp</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt id="link-27" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> <tt class="py-comment"># Remove stale cache.</tt> </tt>
+<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">k</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">_</tt><tt class="py-op">,</tt> <tt class="py-name">timestamp</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt id="link-27" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-27', 'cache', 'link-8');">cache</a></tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
-<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-28" class="py-name"><a title="googleapiclient.discovery_cache.file_cache._to_timestamp" class="py-name" href="#" onclick="return doclink('link-28', '_to_timestamp', 'link-20');">_to_timestamp</a></tt><tt class="py-op">(</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">now</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">>=</tt> <tt class="py-name">timestamp</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_max_age</tt><tt class="py-op">:</tt> </tt>
-<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt id="link-29" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-28" class="py-name"><a title="googleapiclient.discovery_cache.file_cache._to_timestamp" class="py-name" href="#" onclick="return doclink('link-28', '_to_timestamp', 'link-20');">_to_timestamp</a></tt><tt class="py-op">(</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">now</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">>=</tt> <tt class="py-name">timestamp</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_max_age</tt><tt class="py-op">:</tt> </tt>
+<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt id="link-29" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-29', 'cache', 'link-8');">cache</a></tt><tt class="py-op">[</tt><tt class="py-name">k</tt><tt class="py-op">]</tt> </tt>
-<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">truncate</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
-<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">seek</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
-<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">dump</tt><tt class="py-op">(</tt><tt id="link-30" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">truncate</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
+<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">seek</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
+<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">dump</tt><tt class="py-op">(</tt><tt id="link-30" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-30', 'cache', 'link-8');">cache</a></tt><tt class="py-op">,</tt> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">file_handle</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
-<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
-<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"> <tt id="link-31" class="py-name"><a title="googleapiclient.discovery_cache.LOGGER
+<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> <tt id="link-31" class="py-name"><a title="googleapiclient.discovery_cache.LOGGER
googleapiclient.discovery_cache.appengine_memcache.LOGGER
googleapiclient.discovery_cache.file_cache.LOGGER
googleapiclient.http.LOGGER
googleapiclient.model.LOGGER" class="py-name" href="#" onclick="return doclink('link-31', 'LOGGER', 'link-3');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">'Could not obtain a lock for the cache file.'</tt><tt class="py-op">)</tt> </tt>
-<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt> <tt class="py-keyword">as</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
-<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> <tt id="link-32" class="py-name"><a title="googleapiclient.discovery_cache.LOGGER
+<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt> <tt class="py-keyword">as</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
+<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"> <tt id="link-32" class="py-name"><a title="googleapiclient.discovery_cache.LOGGER
googleapiclient.discovery_cache.appengine_memcache.LOGGER
googleapiclient.discovery_cache.file_cache.LOGGER
googleapiclient.http.LOGGER
googleapiclient.model.LOGGER" class="py-name" href="#" onclick="return doclink('link-32', 'LOGGER', 'link-3');">LOGGER</a></tt><tt class="py-op">.</tt><tt class="py-name">warning</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">,</tt> <tt class="py-name">exc_info</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
-<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
-<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">unlock_and_close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
-</div></div><a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> </tt>
-<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"> </tt>
-<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"><tt id="link-33" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
+<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
+<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">unlock_and_close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
+</div></div><a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> </tt>
+<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> </tt>
+<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"><tt id="link-33" class="py-name"><a title="googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.file_cache.cache" class="py-name" href="#" onclick="return doclink('link-33', 'cache', 'link-8');">cache</a></tt> <tt class="py-op">=</tt> <tt id="link-34" class="py-name" targets="Class googleapiclient.discovery_cache.appengine_memcache.Cache=googleapiclient.discovery_cache.appengine_memcache.Cache-class.html,Class googleapiclient.discovery_cache.base.Cache=googleapiclient.discovery_cache.base.Cache-class.html,Class googleapiclient.discovery_cache.file_cache.Cache=googleapiclient.discovery_cache.file_cache.Cache-class.html"><a title="googleapiclient.discovery_cache.appengine_memcache.Cache
googleapiclient.discovery_cache.base.Cache
googleapiclient.discovery_cache.file_cache.Cache" class="py-name" href="#" onclick="return doclink('link-34', 'Cache', 'link-34');">Cache</a></tt><tt class="py-op">(</tt><tt class="py-name">max_age</tt><tt class="py-op">=</tt><tt id="link-35" class="py-name"><a title="googleapiclient.discovery_cache.DISCOVERY_DOC_MAX_AGE" class="py-name" href="#" onclick="return doclink('link-35', 'DISCOVERY_DOC_MAX_AGE', 'link-2');">DISCOVERY_DOC_MAX_AGE</a></tt><tt class="py-op">)</tt> </tt>
-<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> </tt><script type="text/javascript">
+<a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
@@ -271,7 +276,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.file_cache.Cache-class.html b/docs/epy/googleapiclient.discovery_cache.file_cache.Cache-class.html
index 338a3a1..6884731 100644
--- a/docs/epy/googleapiclient.discovery_cache.file_cache.Cache-class.html
+++ b/docs/epy/googleapiclient.discovery_cache.file_cache.Cache-class.html
@@ -60,12 +60,12 @@
<h1 class="epydoc">Class Cache</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery_cache.file_cache-pysrc.html#Cache">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_9" name="uml_class_diagram_for_googleap_9">
-<area shape="rect" id="node1_4" href="googleapiclient.discovery_cache.file_cache.Cache-class.html#__init__" title="Constructor." alt="" coords="18,111,161,129"/>
-<area shape="rect" id="node1_5" href="googleapiclient.discovery_cache.file_cache.Cache-class.html#get" title="Gets the content from the memcache with a given key." alt="" coords="18,129,161,148"/>
-<area shape="rect" id="node1_6" href="googleapiclient.discovery_cache.file_cache.Cache-class.html#set" title="Sets the given key and content in the cache." alt="" coords="18,148,161,167"/>
-<area shape="rect" id="node1" href="googleapiclient.discovery_cache.file_cache.Cache-class.html" title="A file based cache for the discovery documents." alt="" coords="5,80,172,173"/>
-<area shape="rect" id="node2_7" href="googleapiclient.discovery_cache.base.Cache-class.html#__metaclass__" title="googleapiclient.discovery_cache.base.Cache.__metaclass__" alt="" coords="42,28,137,47"/>
-<area shape="rect" id="node2" href="googleapiclient.discovery_cache.base.Cache-class.html" title="A base abstract cache class." alt="" coords="29,5,148,61"/>
+<area shape="rect" id="node1_4" href="googleapiclient.discovery_cache.file_cache.Cache-class.html#__init__" title="Constructor." alt="" coords="17,120,160,140"/>
+<area shape="rect" id="node1_5" href="googleapiclient.discovery_cache.file_cache.Cache-class.html#get" title="Gets the content from the memcache with a given key." alt="" coords="17,140,160,160"/>
+<area shape="rect" id="node1_6" href="googleapiclient.discovery_cache.file_cache.Cache-class.html#set" title="Sets the given key and content in the cache." alt="" coords="17,160,160,180"/>
+<area shape="rect" id="node1" href="googleapiclient.discovery_cache.file_cache.Cache-class.html" title="A file based cache for the discovery documents." alt="" coords="5,86,171,186"/>
+<area shape="rect" id="node2_7" href="googleapiclient.discovery_cache.base.Cache-class.html#__metaclass__" title="googleapiclient.discovery_cache.base.Cache.__metaclass__" alt="" coords="41,32,137,52"/>
+<area shape="rect" id="node2" href="googleapiclient.discovery_cache.base.Cache-class.html" title="A base abstract cache class." alt="" coords="29,6,149,66"/>
</map>
<img src="uml_class_diagram_for_googleap_9.gif" alt='' usemap="#uml_class_diagram_for_googleap_9" ismap="ismap" class="graph-without-title" />
</center>
@@ -358,7 +358,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors-module.html b/docs/epy/googleapiclient.errors-module.html
index b59ac01..fedda66 100644
--- a/docs/epy/googleapiclient.errors-module.html
+++ b/docs/epy/googleapiclient.errors-module.html
@@ -224,7 +224,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors-pysrc.html b/docs/epy/googleapiclient.errors-pysrc.html
index a673312..5773edc 100644
--- a/docs/epy/googleapiclient.errors-pysrc.html
+++ b/docs/epy/googleapiclient.errors-pysrc.html
@@ -293,7 +293,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.BatchError-class.html b/docs/epy/googleapiclient.errors.BatchError-class.html
index 0e64301..345d34c 100644
--- a/docs/epy/googleapiclient.errors.BatchError-class.html
+++ b/docs/epy/googleapiclient.errors.BatchError-class.html
@@ -59,25 +59,25 @@
<h1 class="epydoc">Class BatchError</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#BatchError">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_10" name="uml_class_diagram_for_googleap_10">
-<area shape="rect" id="node1_14" href="googleapiclient.errors.BatchError-class.html#__init__" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="17,471,311,489"/>
-<area shape="rect" id="node1_15" href="googleapiclient.errors.BatchError-class.html#__repr__" title="str(x)" alt="" coords="17,489,311,508"/>
-<area shape="rect" id="node1_16" href="googleapiclient.errors.BatchError-class.html#__str__" title="str(x)" alt="" coords="17,508,311,527"/>
-<area shape="rect" id="node1" href="googleapiclient.errors.BatchError-class.html" title="Error occured during batch operations." alt="" coords="5,440,323,533"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.HttpError-class.html" title="HTTP data was invalid or unexpected." alt="" coords="125,379,203,421"/>
-<area shape="rect" id="node3_17" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="85,28,241,47"/>
-<area shape="rect" id="node3_18" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="85,47,241,65"/>
-<area shape="rect" id="node3_19" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="85,68,241,87"/>
-<area shape="rect" id="node3_20" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="85,87,241,105"/>
-<area shape="rect" id="node3_21" href="javascript:void(0);" title="x[y]" alt="" coords="85,105,241,124"/>
-<area shape="rect" id="node3_22" href="javascript:void(0);" title="x[i:j]" alt="" coords="85,124,241,143"/>
-<area shape="rect" id="node3_23" href="javascript:void(0);" title="helper for pickle" alt="" coords="85,143,241,161"/>
-<area shape="rect" id="node3_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="85,161,241,180"/>
-<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="85,180,241,199"/>
-<area shape="rect" id="node3_26" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="85,199,241,217"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="73,5,253,224"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="101,273,227,292"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="89,243,239,299"/>
-<area shape="rect" id="node5" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="137,317,191,360"/>
+<area shape="rect" id="node1_14" href="googleapiclient.errors.BatchError-class.html#__init__" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="17,501,308,521"/>
+<area shape="rect" id="node1_15" href="googleapiclient.errors.BatchError-class.html#__repr__" title="str(x)" alt="" coords="17,521,308,541"/>
+<area shape="rect" id="node1_16" href="googleapiclient.errors.BatchError-class.html#__str__" title="str(x)" alt="" coords="17,541,308,561"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.BatchError-class.html" title="Error occured during batch operations." alt="" coords="5,467,320,567"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.HttpError-class.html" title="HTTP data was invalid or unexpected." alt="" coords="122,403,201,448"/>
+<area shape="rect" id="node3" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="134,339,189,384"/>
+<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="84,31,241,51"/>
+<area shape="rect" id="node4_18" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="84,51,241,71"/>
+<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="84,73,241,93"/>
+<area shape="rect" id="node4_20" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="84,93,241,113"/>
+<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[y]" alt="" coords="84,113,241,133"/>
+<area shape="rect" id="node4_22" href="javascript:void(0);" title="x[i:j]" alt="" coords="84,133,241,153"/>
+<area shape="rect" id="node4_23" href="javascript:void(0);" title="helper for pickle" alt="" coords="84,153,241,173"/>
+<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="84,173,241,193"/>
+<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="84,193,241,213"/>
+<area shape="rect" id="node4_26" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="84,213,241,233"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="72,5,253,240"/>
+<area shape="rect" id="node5_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="99,293,225,313"/>
+<area shape="rect" id="node5" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="86,259,237,319"/>
</map>
<img src="uml_class_diagram_for_googleap_10.gif" alt='' usemap="#uml_class_diagram_for_googleap_10" ismap="ismap" class="graph-without-title" />
</center>
@@ -349,7 +349,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.Error-class.html b/docs/epy/googleapiclient.errors.Error-class.html
index 262a8b0..30893eb 100644
--- a/docs/epy/googleapiclient.errors.Error-class.html
+++ b/docs/epy/googleapiclient.errors.Error-class.html
@@ -59,23 +59,23 @@
<h1 class="epydoc">Class Error</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#Error">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_11" name="uml_class_diagram_for_googleap_11">
-<area shape="rect" id="node1" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="70,373,123,416"/>
-<area shape="rect" id="node2_14" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="34,311,159,329"/>
-<area shape="rect" id="node2_15" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="34,329,159,348"/>
-<area shape="rect" id="node2" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="22,280,171,355"/>
-<area shape="rect" id="node3_16" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="18,28,174,47"/>
-<area shape="rect" id="node3_17" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="18,47,174,65"/>
-<area shape="rect" id="node3_18" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="18,68,174,87"/>
-<area shape="rect" id="node3_19" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="18,87,174,105"/>
-<area shape="rect" id="node3_20" href="javascript:void(0);" title="x[y]" alt="" coords="18,105,174,124"/>
-<area shape="rect" id="node3_21" href="javascript:void(0);" title="x[i:j]" alt="" coords="18,124,174,143"/>
-<area shape="rect" id="node3_22" href="javascript:void(0);" title="helper for pickle" alt="" coords="18,143,174,161"/>
-<area shape="rect" id="node3_23" href="javascript:void(0);" title="repr(x)" alt="" coords="18,161,174,180"/>
-<area shape="rect" id="node3_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="18,180,174,199"/>
-<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="18,199,174,217"/>
-<area shape="rect" id="node3_26" href="javascript:void(0);" title="str(x)" alt="" coords="18,217,174,236"/>
-<area shape="rect" id="node3_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="18,236,174,255"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,185,261"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="67,397,122,443"/>
+<area shape="rect" id="node2_14" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="32,332,159,352"/>
+<area shape="rect" id="node2_15" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="32,352,159,372"/>
+<area shape="rect" id="node2" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="19,299,170,379"/>
+<area shape="rect" id="node3_16" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="17,31,175,51"/>
+<area shape="rect" id="node3_17" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="17,51,175,71"/>
+<area shape="rect" id="node3_18" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="17,73,175,93"/>
+<area shape="rect" id="node3_19" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="17,93,175,113"/>
+<area shape="rect" id="node3_20" href="javascript:void(0);" title="x[y]" alt="" coords="17,113,175,133"/>
+<area shape="rect" id="node3_21" href="javascript:void(0);" title="x[i:j]" alt="" coords="17,133,175,153"/>
+<area shape="rect" id="node3_22" href="javascript:void(0);" title="helper for pickle" alt="" coords="17,153,175,173"/>
+<area shape="rect" id="node3_23" href="javascript:void(0);" title="repr(x)" alt="" coords="17,173,175,193"/>
+<area shape="rect" id="node3_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="17,193,175,213"/>
+<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="17,213,175,233"/>
+<area shape="rect" id="node3_26" href="javascript:void(0);" title="str(x)" alt="" coords="17,233,175,253"/>
+<area shape="rect" id="node3_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="17,253,175,273"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,187,280"/>
</map>
<img src="uml_class_diagram_for_googleap_11.gif" alt='' usemap="#uml_class_diagram_for_googleap_11" ismap="ismap" class="graph-without-title" />
</center>
@@ -186,7 +186,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.HttpError-class.html b/docs/epy/googleapiclient.errors.HttpError-class.html
index 83b0153..bc9bde1 100644
--- a/docs/epy/googleapiclient.errors.HttpError-class.html
+++ b/docs/epy/googleapiclient.errors.HttpError-class.html
@@ -59,24 +59,24 @@
<h1 class="epydoc">Class HttpError</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#HttpError">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_12" name="uml_class_diagram_for_googleap_12">
-<area shape="rect" id="node1_14" href="googleapiclient.errors.HttpError-class.html#__init__" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="18,409,246,428"/>
-<area shape="rect" id="node1_15" href="googleapiclient.errors.HttpError-class.html#__repr__" title="str(x)" alt="" coords="18,428,246,447"/>
-<area shape="rect" id="node1_16" href="googleapiclient.errors.HttpError-class.html#__str__" title="str(x)" alt="" coords="18,447,246,465"/>
-<area shape="rect" id="node1" href="googleapiclient.errors.HttpError-class.html" title="HTTP data was invalid or unexpected." alt="" coords="5,379,257,472"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="106,317,159,360"/>
-<area shape="rect" id="node3_17" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="70,273,195,292"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="58,243,207,299"/>
-<area shape="rect" id="node4_18" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="54,28,210,47"/>
-<area shape="rect" id="node4_19" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="54,47,210,65"/>
-<area shape="rect" id="node4_20" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="54,68,210,87"/>
-<area shape="rect" id="node4_21" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="54,87,210,105"/>
-<area shape="rect" id="node4_22" href="javascript:void(0);" title="x[y]" alt="" coords="54,105,210,124"/>
-<area shape="rect" id="node4_23" href="javascript:void(0);" title="x[i:j]" alt="" coords="54,124,210,143"/>
-<area shape="rect" id="node4_24" href="javascript:void(0);" title="helper for pickle" alt="" coords="54,143,210,161"/>
-<area shape="rect" id="node4_25" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="54,161,210,180"/>
-<area shape="rect" id="node4_26" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="54,180,210,199"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="54,199,210,217"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="41,5,221,224"/>
+<area shape="rect" id="node1_14" href="googleapiclient.errors.HttpError-class.html#__init__" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="17,437,244,457"/>
+<area shape="rect" id="node1_15" href="googleapiclient.errors.HttpError-class.html#__repr__" title="str(x)" alt="" coords="17,457,244,477"/>
+<area shape="rect" id="node1_16" href="googleapiclient.errors.HttpError-class.html#__str__" title="str(x)" alt="" coords="17,477,244,497"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.HttpError-class.html" title="HTTP data was invalid or unexpected." alt="" coords="5,403,256,503"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="102,339,157,384"/>
+<area shape="rect" id="node3_17" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="52,31,209,51"/>
+<area shape="rect" id="node3_18" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="52,51,209,71"/>
+<area shape="rect" id="node3_19" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="52,73,209,93"/>
+<area shape="rect" id="node3_20" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="52,93,209,113"/>
+<area shape="rect" id="node3_21" href="javascript:void(0);" title="x[y]" alt="" coords="52,113,209,133"/>
+<area shape="rect" id="node3_22" href="javascript:void(0);" title="x[i:j]" alt="" coords="52,133,209,153"/>
+<area shape="rect" id="node3_23" href="javascript:void(0);" title="helper for pickle" alt="" coords="52,153,209,173"/>
+<area shape="rect" id="node3_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="52,173,209,193"/>
+<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="52,193,209,213"/>
+<area shape="rect" id="node3_26" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="52,213,209,233"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="40,5,221,240"/>
+<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="67,293,193,313"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="54,259,205,319"/>
</map>
<img src="uml_class_diagram_for_googleap_12.gif" alt='' usemap="#uml_class_diagram_for_googleap_12" ismap="ismap" class="graph-without-title" />
</center>
@@ -362,7 +362,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html b/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html
index 04f4258..3035864 100644
--- a/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html
+++ b/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html
@@ -59,24 +59,24 @@
<h1 class="epydoc">Class InvalidChunkSizeError</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#InvalidChunkSizeError">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_13" name="uml_class_diagram_for_googleap_13">
-<area shape="rect" id="node1" href="googleapiclient.errors.InvalidChunkSizeError-class.html" title="The given chunksize is not valid." alt="" coords="17,435,173,477"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="70,373,123,416"/>
-<area shape="rect" id="node3_14" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="34,311,159,329"/>
-<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="34,329,159,348"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="22,280,171,355"/>
-<area shape="rect" id="node4_16" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="18,28,174,47"/>
-<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="18,47,174,65"/>
-<area shape="rect" id="node4_18" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="18,68,174,87"/>
-<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="18,87,174,105"/>
-<area shape="rect" id="node4_20" href="javascript:void(0);" title="x[y]" alt="" coords="18,105,174,124"/>
-<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[i:j]" alt="" coords="18,124,174,143"/>
-<area shape="rect" id="node4_22" href="javascript:void(0);" title="helper for pickle" alt="" coords="18,143,174,161"/>
-<area shape="rect" id="node4_23" href="javascript:void(0);" title="repr(x)" alt="" coords="18,161,174,180"/>
-<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="18,180,174,199"/>
-<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="18,199,174,217"/>
-<area shape="rect" id="node4_26" href="javascript:void(0);" title="str(x)" alt="" coords="18,217,174,236"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="18,236,174,255"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,185,261"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.InvalidChunkSizeError-class.html" title="The given chunksize is not valid." alt="" coords="17,461,173,507"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="67,397,122,443"/>
+<area shape="rect" id="node3_14" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="17,31,175,51"/>
+<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="17,51,175,71"/>
+<area shape="rect" id="node3_16" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="17,73,175,93"/>
+<area shape="rect" id="node3_17" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="17,93,175,113"/>
+<area shape="rect" id="node3_18" href="javascript:void(0);" title="x[y]" alt="" coords="17,113,175,133"/>
+<area shape="rect" id="node3_19" href="javascript:void(0);" title="x[i:j]" alt="" coords="17,133,175,153"/>
+<area shape="rect" id="node3_20" href="javascript:void(0);" title="helper for pickle" alt="" coords="17,153,175,173"/>
+<area shape="rect" id="node3_21" href="javascript:void(0);" title="repr(x)" alt="" coords="17,173,175,193"/>
+<area shape="rect" id="node3_22" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="17,193,175,213"/>
+<area shape="rect" id="node3_23" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="17,213,175,233"/>
+<area shape="rect" id="node3_24" href="javascript:void(0);" title="str(x)" alt="" coords="17,233,175,253"/>
+<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="17,253,175,273"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,187,280"/>
+<area shape="rect" id="node4_26" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="32,332,159,352"/>
+<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="32,352,159,372"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="19,299,170,379"/>
</map>
<img src="uml_class_diagram_for_googleap_13.gif" alt='' usemap="#uml_class_diagram_for_googleap_13" ismap="ismap" class="graph-without-title" />
</center>
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.InvalidJsonError-class.html b/docs/epy/googleapiclient.errors.InvalidJsonError-class.html
index 78cc8d0..d09ca0d 100644
--- a/docs/epy/googleapiclient.errors.InvalidJsonError-class.html
+++ b/docs/epy/googleapiclient.errors.InvalidJsonError-class.html
@@ -59,24 +59,24 @@
<h1 class="epydoc">Class InvalidJsonError</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#InvalidJsonError">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_14" name="uml_class_diagram_for_googleap_14">
-<area shape="rect" id="node1" href="googleapiclient.errors.InvalidJsonError-class.html" title="The JSON returned could not be parsed." alt="" coords="37,435,157,477"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="70,373,123,416"/>
-<area shape="rect" id="node3_14" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="34,311,159,329"/>
-<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="34,329,159,348"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="22,280,171,355"/>
-<area shape="rect" id="node4_16" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="18,28,174,47"/>
-<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="18,47,174,65"/>
-<area shape="rect" id="node4_18" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="18,68,174,87"/>
-<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="18,87,174,105"/>
-<area shape="rect" id="node4_20" href="javascript:void(0);" title="x[y]" alt="" coords="18,105,174,124"/>
-<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[i:j]" alt="" coords="18,124,174,143"/>
-<area shape="rect" id="node4_22" href="javascript:void(0);" title="helper for pickle" alt="" coords="18,143,174,161"/>
-<area shape="rect" id="node4_23" href="javascript:void(0);" title="repr(x)" alt="" coords="18,161,174,180"/>
-<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="18,180,174,199"/>
-<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="18,199,174,217"/>
-<area shape="rect" id="node4_26" href="javascript:void(0);" title="str(x)" alt="" coords="18,217,174,236"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="18,236,174,255"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,185,261"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.InvalidJsonError-class.html" title="The JSON returned could not be parsed." alt="" coords="36,461,156,507"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="67,397,122,443"/>
+<area shape="rect" id="node3_14" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="17,31,175,51"/>
+<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="17,51,175,71"/>
+<area shape="rect" id="node3_16" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="17,73,175,93"/>
+<area shape="rect" id="node3_17" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="17,93,175,113"/>
+<area shape="rect" id="node3_18" href="javascript:void(0);" title="x[y]" alt="" coords="17,113,175,133"/>
+<area shape="rect" id="node3_19" href="javascript:void(0);" title="x[i:j]" alt="" coords="17,133,175,153"/>
+<area shape="rect" id="node3_20" href="javascript:void(0);" title="helper for pickle" alt="" coords="17,153,175,173"/>
+<area shape="rect" id="node3_21" href="javascript:void(0);" title="repr(x)" alt="" coords="17,173,175,193"/>
+<area shape="rect" id="node3_22" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="17,193,175,213"/>
+<area shape="rect" id="node3_23" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="17,213,175,233"/>
+<area shape="rect" id="node3_24" href="javascript:void(0);" title="str(x)" alt="" coords="17,233,175,253"/>
+<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="17,253,175,273"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,187,280"/>
+<area shape="rect" id="node4_26" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="32,332,159,352"/>
+<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="32,352,159,372"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="19,299,170,379"/>
</map>
<img src="uml_class_diagram_for_googleap_14.gif" alt='' usemap="#uml_class_diagram_for_googleap_14" ismap="ismap" class="graph-without-title" />
</center>
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html b/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html
index 970dacf..a684236 100644
--- a/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html
+++ b/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html
@@ -59,24 +59,24 @@
<h1 class="epydoc">Class InvalidNotificationError</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#InvalidNotificationError">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_15" name="uml_class_diagram_for_googleap_15">
-<area shape="rect" id="node1" href="googleapiclient.errors.InvalidNotificationError-class.html" title="The channel Notification is invalid." alt="" coords="18,435,175,477"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="70,373,123,416"/>
-<area shape="rect" id="node3_14" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="34,311,159,329"/>
-<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="34,329,159,348"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="22,280,171,355"/>
-<area shape="rect" id="node4_16" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="18,28,174,47"/>
-<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="18,47,174,65"/>
-<area shape="rect" id="node4_18" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="18,68,174,87"/>
-<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="18,87,174,105"/>
-<area shape="rect" id="node4_20" href="javascript:void(0);" title="x[y]" alt="" coords="18,105,174,124"/>
-<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[i:j]" alt="" coords="18,124,174,143"/>
-<area shape="rect" id="node4_22" href="javascript:void(0);" title="helper for pickle" alt="" coords="18,143,174,161"/>
-<area shape="rect" id="node4_23" href="javascript:void(0);" title="repr(x)" alt="" coords="18,161,174,180"/>
-<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="18,180,174,199"/>
-<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="18,199,174,217"/>
-<area shape="rect" id="node4_26" href="javascript:void(0);" title="str(x)" alt="" coords="18,217,174,236"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="18,236,174,255"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,185,261"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.InvalidNotificationError-class.html" title="The channel Notification is invalid." alt="" coords="15,461,174,507"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="67,397,122,443"/>
+<area shape="rect" id="node3_14" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="17,31,175,51"/>
+<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="17,51,175,71"/>
+<area shape="rect" id="node3_16" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="17,73,175,93"/>
+<area shape="rect" id="node3_17" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="17,93,175,113"/>
+<area shape="rect" id="node3_18" href="javascript:void(0);" title="x[y]" alt="" coords="17,113,175,133"/>
+<area shape="rect" id="node3_19" href="javascript:void(0);" title="x[i:j]" alt="" coords="17,133,175,153"/>
+<area shape="rect" id="node3_20" href="javascript:void(0);" title="helper for pickle" alt="" coords="17,153,175,173"/>
+<area shape="rect" id="node3_21" href="javascript:void(0);" title="repr(x)" alt="" coords="17,173,175,193"/>
+<area shape="rect" id="node3_22" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="17,193,175,213"/>
+<area shape="rect" id="node3_23" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="17,213,175,233"/>
+<area shape="rect" id="node3_24" href="javascript:void(0);" title="str(x)" alt="" coords="17,233,175,253"/>
+<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="17,253,175,273"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,187,280"/>
+<area shape="rect" id="node4_26" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="32,332,159,352"/>
+<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="32,352,159,372"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="19,299,170,379"/>
</map>
<img src="uml_class_diagram_for_googleap_15.gif" alt='' usemap="#uml_class_diagram_for_googleap_15" ismap="ismap" class="graph-without-title" />
</center>
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html b/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html
index 84eda6e..c3207be 100644
--- a/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html
+++ b/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html
@@ -59,24 +59,24 @@
<h1 class="epydoc">Class MediaUploadSizeError</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#MediaUploadSizeError">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_16" name="uml_class_diagram_for_googleap_16">
-<area shape="rect" id="node1" href="googleapiclient.errors.MediaUploadSizeError-class.html" title="Media is larger than the method can accept." alt="" coords="18,435,175,477"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="70,373,123,416"/>
-<area shape="rect" id="node3_14" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="34,311,159,329"/>
-<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="34,329,159,348"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="22,280,171,355"/>
-<area shape="rect" id="node4_16" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="18,28,174,47"/>
-<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="18,47,174,65"/>
-<area shape="rect" id="node4_18" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="18,68,174,87"/>
-<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="18,87,174,105"/>
-<area shape="rect" id="node4_20" href="javascript:void(0);" title="x[y]" alt="" coords="18,105,174,124"/>
-<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[i:j]" alt="" coords="18,124,174,143"/>
-<area shape="rect" id="node4_22" href="javascript:void(0);" title="helper for pickle" alt="" coords="18,143,174,161"/>
-<area shape="rect" id="node4_23" href="javascript:void(0);" title="repr(x)" alt="" coords="18,161,174,180"/>
-<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="18,180,174,199"/>
-<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="18,199,174,217"/>
-<area shape="rect" id="node4_26" href="javascript:void(0);" title="str(x)" alt="" coords="18,217,174,236"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="18,236,174,255"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,185,261"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.MediaUploadSizeError-class.html" title="Media is larger than the method can accept." alt="" coords="17,461,173,507"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="67,397,122,443"/>
+<area shape="rect" id="node3_14" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="17,31,175,51"/>
+<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="17,51,175,71"/>
+<area shape="rect" id="node3_16" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="17,73,175,93"/>
+<area shape="rect" id="node3_17" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="17,93,175,113"/>
+<area shape="rect" id="node3_18" href="javascript:void(0);" title="x[y]" alt="" coords="17,113,175,133"/>
+<area shape="rect" id="node3_19" href="javascript:void(0);" title="x[i:j]" alt="" coords="17,133,175,153"/>
+<area shape="rect" id="node3_20" href="javascript:void(0);" title="helper for pickle" alt="" coords="17,153,175,173"/>
+<area shape="rect" id="node3_21" href="javascript:void(0);" title="repr(x)" alt="" coords="17,173,175,193"/>
+<area shape="rect" id="node3_22" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="17,193,175,213"/>
+<area shape="rect" id="node3_23" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="17,213,175,233"/>
+<area shape="rect" id="node3_24" href="javascript:void(0);" title="str(x)" alt="" coords="17,233,175,253"/>
+<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="17,253,175,273"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,187,280"/>
+<area shape="rect" id="node4_26" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="32,332,159,352"/>
+<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="32,352,159,372"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="19,299,170,379"/>
</map>
<img src="uml_class_diagram_for_googleap_16.gif" alt='' usemap="#uml_class_diagram_for_googleap_16" ismap="ismap" class="graph-without-title" />
</center>
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.ResumableUploadError-class.html b/docs/epy/googleapiclient.errors.ResumableUploadError-class.html
index 2aa79c9..2205d4b 100644
--- a/docs/epy/googleapiclient.errors.ResumableUploadError-class.html
+++ b/docs/epy/googleapiclient.errors.ResumableUploadError-class.html
@@ -59,25 +59,25 @@
<h1 class="epydoc">Class ResumableUploadError</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#ResumableUploadError">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_17" name="uml_class_diagram_for_googleap_17">
-<area shape="rect" id="node1" href="googleapiclient.errors.ResumableUploadError-class.html" title="Error occured during resumable upload." alt="" coords="51,491,214,533"/>
-<area shape="rect" id="node2_14" href="googleapiclient.errors.HttpError-class.html#__init__" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="18,409,246,428"/>
-<area shape="rect" id="node2_15" href="googleapiclient.errors.HttpError-class.html#__repr__" title="str(x)" alt="" coords="18,428,246,447"/>
-<area shape="rect" id="node2_16" href="googleapiclient.errors.HttpError-class.html#__str__" title="str(x)" alt="" coords="18,447,246,465"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.HttpError-class.html" title="HTTP data was invalid or unexpected." alt="" coords="5,379,257,472"/>
-<area shape="rect" id="node3_17" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="54,28,210,47"/>
-<area shape="rect" id="node3_18" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="54,47,210,65"/>
-<area shape="rect" id="node3_19" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="54,68,210,87"/>
-<area shape="rect" id="node3_20" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="54,87,210,105"/>
-<area shape="rect" id="node3_21" href="javascript:void(0);" title="x[y]" alt="" coords="54,105,210,124"/>
-<area shape="rect" id="node3_22" href="javascript:void(0);" title="x[i:j]" alt="" coords="54,124,210,143"/>
-<area shape="rect" id="node3_23" href="javascript:void(0);" title="helper for pickle" alt="" coords="54,143,210,161"/>
-<area shape="rect" id="node3_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="54,161,210,180"/>
-<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="54,180,210,199"/>
-<area shape="rect" id="node3_26" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="54,199,210,217"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="41,5,221,224"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="70,273,195,292"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="58,243,207,299"/>
-<area shape="rect" id="node5" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="106,317,159,360"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.ResumableUploadError-class.html" title="Error occured during resumable upload." alt="" coords="49,523,210,568"/>
+<area shape="rect" id="node2_14" href="googleapiclient.errors.HttpError-class.html#__init__" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="17,437,244,457"/>
+<area shape="rect" id="node2_15" href="googleapiclient.errors.HttpError-class.html#__repr__" title="str(x)" alt="" coords="17,457,244,477"/>
+<area shape="rect" id="node2_16" href="googleapiclient.errors.HttpError-class.html#__str__" title="str(x)" alt="" coords="17,477,244,497"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.HttpError-class.html" title="HTTP data was invalid or unexpected." alt="" coords="5,403,256,503"/>
+<area shape="rect" id="node3" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="102,339,157,384"/>
+<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="52,31,209,51"/>
+<area shape="rect" id="node4_18" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="52,51,209,71"/>
+<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="52,73,209,93"/>
+<area shape="rect" id="node4_20" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="52,93,209,113"/>
+<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[y]" alt="" coords="52,113,209,133"/>
+<area shape="rect" id="node4_22" href="javascript:void(0);" title="x[i:j]" alt="" coords="52,133,209,153"/>
+<area shape="rect" id="node4_23" href="javascript:void(0);" title="helper for pickle" alt="" coords="52,153,209,173"/>
+<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="52,173,209,193"/>
+<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="52,193,209,213"/>
+<area shape="rect" id="node4_26" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="52,213,209,233"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="40,5,221,240"/>
+<area shape="rect" id="node5_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="67,293,193,313"/>
+<area shape="rect" id="node5" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="54,259,205,319"/>
</map>
<img src="uml_class_diagram_for_googleap_17.gif" alt='' usemap="#uml_class_diagram_for_googleap_17" ismap="ismap" class="graph-without-title" />
</center>
@@ -193,7 +193,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html b/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html
index 98c3408..f99bb39 100644
--- a/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html
+++ b/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html
@@ -59,24 +59,24 @@
<h1 class="epydoc">Class UnacceptableMimeTypeError</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#UnacceptableMimeTypeError">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_18" name="uml_class_diagram_for_googleap_18">
-<area shape="rect" id="node1" href="googleapiclient.errors.UnacceptableMimeTypeError-class.html" title="That is an unacceptable mimetype for this operation." alt="" coords="5,435,201,477"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="78,373,131,416"/>
-<area shape="rect" id="node3_14" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="42,311,167,329"/>
-<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="42,329,167,348"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="30,280,179,355"/>
-<area shape="rect" id="node4_16" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="26,28,182,47"/>
-<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="26,47,182,65"/>
-<area shape="rect" id="node4_18" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="26,68,182,87"/>
-<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="26,87,182,105"/>
-<area shape="rect" id="node4_20" href="javascript:void(0);" title="x[y]" alt="" coords="26,105,182,124"/>
-<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[i:j]" alt="" coords="26,124,182,143"/>
-<area shape="rect" id="node4_22" href="javascript:void(0);" title="helper for pickle" alt="" coords="26,143,182,161"/>
-<area shape="rect" id="node4_23" href="javascript:void(0);" title="repr(x)" alt="" coords="26,161,182,180"/>
-<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="26,180,182,199"/>
-<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="26,199,182,217"/>
-<area shape="rect" id="node4_26" href="javascript:void(0);" title="str(x)" alt="" coords="26,217,182,236"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="26,236,182,255"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="13,5,193,261"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.UnacceptableMimeTypeError-class.html" title="That is an unacceptable mimetype for this operation." alt="" coords="5,461,200,507"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="74,397,129,443"/>
+<area shape="rect" id="node3_14" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="24,31,181,51"/>
+<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="24,51,181,71"/>
+<area shape="rect" id="node3_16" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="24,73,181,93"/>
+<area shape="rect" id="node3_17" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="24,93,181,113"/>
+<area shape="rect" id="node3_18" href="javascript:void(0);" title="x[y]" alt="" coords="24,113,181,133"/>
+<area shape="rect" id="node3_19" href="javascript:void(0);" title="x[i:j]" alt="" coords="24,133,181,153"/>
+<area shape="rect" id="node3_20" href="javascript:void(0);" title="helper for pickle" alt="" coords="24,153,181,173"/>
+<area shape="rect" id="node3_21" href="javascript:void(0);" title="repr(x)" alt="" coords="24,173,181,193"/>
+<area shape="rect" id="node3_22" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="24,193,181,213"/>
+<area shape="rect" id="node3_23" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="24,213,181,233"/>
+<area shape="rect" id="node3_24" href="javascript:void(0);" title="str(x)" alt="" coords="24,233,181,253"/>
+<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="24,253,181,273"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="12,5,193,280"/>
+<area shape="rect" id="node4_26" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="39,332,165,352"/>
+<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="39,352,165,372"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="26,299,177,379"/>
</map>
<img src="uml_class_diagram_for_googleap_18.gif" alt='' usemap="#uml_class_diagram_for_googleap_18" ismap="ismap" class="graph-without-title" />
</center>
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html b/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html
index 7149aaa..71d3ade 100644
--- a/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html
+++ b/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html
@@ -59,24 +59,24 @@
<h1 class="epydoc">Class UnexpectedBodyError</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#UnexpectedBodyError">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_19" name="uml_class_diagram_for_googleap_19">
-<area shape="rect" id="node1_14" href="googleapiclient.errors.UnexpectedBodyError-class.html#__init__" title="Constructor for an UnexpectedMethodError." alt="" coords="18,447,219,465"/>
-<area shape="rect" id="node1" href="googleapiclient.errors.UnexpectedBodyError-class.html" title="Exception raised by RequestMockBuilder on unexpected bodies." alt="" coords="5,416,231,472"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="93,355,146,397"/>
-<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="57,311,182,329"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="45,280,194,336"/>
-<area shape="rect" id="node4_16" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="41,28,197,47"/>
-<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="41,47,197,65"/>
-<area shape="rect" id="node4_18" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="41,68,197,87"/>
-<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="41,87,197,105"/>
-<area shape="rect" id="node4_20" href="javascript:void(0);" title="x[y]" alt="" coords="41,105,197,124"/>
-<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[i:j]" alt="" coords="41,124,197,143"/>
-<area shape="rect" id="node4_22" href="javascript:void(0);" title="helper for pickle" alt="" coords="41,143,197,161"/>
-<area shape="rect" id="node4_23" href="javascript:void(0);" title="repr(x)" alt="" coords="41,161,197,180"/>
-<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="41,180,197,199"/>
-<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="41,199,197,217"/>
-<area shape="rect" id="node4_26" href="javascript:void(0);" title="str(x)" alt="" coords="41,217,197,236"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="41,236,197,255"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="28,5,208,261"/>
+<area shape="rect" id="node1_14" href="googleapiclient.errors.UnexpectedBodyError-class.html#__init__" title="Constructor for an UnexpectedMethodError." alt="" coords="16,477,216,497"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.UnexpectedBodyError-class.html" title="Exception raised by RequestMockBuilder on unexpected bodies." alt="" coords="4,443,228,503"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="87,379,142,424"/>
+<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="37,31,195,51"/>
+<area shape="rect" id="node3_16" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="37,51,195,71"/>
+<area shape="rect" id="node3_17" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="37,73,195,93"/>
+<area shape="rect" id="node3_18" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="37,93,195,113"/>
+<area shape="rect" id="node3_19" href="javascript:void(0);" title="x[y]" alt="" coords="37,113,195,133"/>
+<area shape="rect" id="node3_20" href="javascript:void(0);" title="x[i:j]" alt="" coords="37,133,195,153"/>
+<area shape="rect" id="node3_21" href="javascript:void(0);" title="helper for pickle" alt="" coords="37,153,195,173"/>
+<area shape="rect" id="node3_22" href="javascript:void(0);" title="repr(x)" alt="" coords="37,173,195,193"/>
+<area shape="rect" id="node3_23" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="37,193,195,213"/>
+<area shape="rect" id="node3_24" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="37,213,195,233"/>
+<area shape="rect" id="node3_25" href="javascript:void(0);" title="str(x)" alt="" coords="37,233,195,253"/>
+<area shape="rect" id="node3_26" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="37,253,195,273"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="25,5,207,280"/>
+<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="52,333,179,353"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="39,299,190,359"/>
</map>
<img src="uml_class_diagram_for_googleap_19.gif" alt='' usemap="#uml_class_diagram_for_googleap_19" ismap="ismap" class="graph-without-title" />
</center>
@@ -252,7 +252,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html b/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html
index cadd422..f2b1795 100644
--- a/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html
+++ b/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html
@@ -59,24 +59,24 @@
<h1 class="epydoc">Class UnexpectedMethodError</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#UnexpectedMethodError">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_20" name="uml_class_diagram_for_googleap_20">
-<area shape="rect" id="node1_14" href="googleapiclient.errors.UnexpectedMethodError-class.html#__init__" title="Constructor for an UnexpectedMethodError." alt="" coords="17,447,201,465"/>
-<area shape="rect" id="node1" href="googleapiclient.errors.UnexpectedMethodError-class.html" title="Exception raised by RequestMockBuilder on unexpected calls." alt="" coords="5,416,213,472"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="83,355,136,397"/>
-<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="47,311,172,329"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="35,280,184,336"/>
-<area shape="rect" id="node4_16" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="31,28,187,47"/>
-<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="31,47,187,65"/>
-<area shape="rect" id="node4_18" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="31,68,187,87"/>
-<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="31,87,187,105"/>
-<area shape="rect" id="node4_20" href="javascript:void(0);" title="x[y]" alt="" coords="31,105,187,124"/>
-<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[i:j]" alt="" coords="31,124,187,143"/>
-<area shape="rect" id="node4_22" href="javascript:void(0);" title="helper for pickle" alt="" coords="31,143,187,161"/>
-<area shape="rect" id="node4_23" href="javascript:void(0);" title="repr(x)" alt="" coords="31,161,187,180"/>
-<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="31,180,187,199"/>
-<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="31,199,187,217"/>
-<area shape="rect" id="node4_26" href="javascript:void(0);" title="str(x)" alt="" coords="31,217,187,236"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="31,236,187,255"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="18,5,198,261"/>
+<area shape="rect" id="node1_14" href="googleapiclient.errors.UnexpectedMethodError-class.html#__init__" title="Constructor for an UnexpectedMethodError." alt="" coords="17,477,200,497"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.UnexpectedMethodError-class.html" title="Exception raised by RequestMockBuilder on unexpected calls." alt="" coords="5,443,211,503"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="81,379,135,424"/>
+<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="31,31,188,51"/>
+<area shape="rect" id="node3_16" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="31,51,188,71"/>
+<area shape="rect" id="node3_17" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="31,73,188,93"/>
+<area shape="rect" id="node3_18" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="31,93,188,113"/>
+<area shape="rect" id="node3_19" href="javascript:void(0);" title="x[y]" alt="" coords="31,113,188,133"/>
+<area shape="rect" id="node3_20" href="javascript:void(0);" title="x[i:j]" alt="" coords="31,133,188,153"/>
+<area shape="rect" id="node3_21" href="javascript:void(0);" title="helper for pickle" alt="" coords="31,153,188,173"/>
+<area shape="rect" id="node3_22" href="javascript:void(0);" title="repr(x)" alt="" coords="31,173,188,193"/>
+<area shape="rect" id="node3_23" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="31,193,188,213"/>
+<area shape="rect" id="node3_24" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="31,213,188,233"/>
+<area shape="rect" id="node3_25" href="javascript:void(0);" title="str(x)" alt="" coords="31,233,188,253"/>
+<area shape="rect" id="node3_26" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="31,253,188,273"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="19,5,200,280"/>
+<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="45,333,172,353"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="33,299,183,359"/>
</map>
<img src="uml_class_diagram_for_googleap_20.gif" alt='' usemap="#uml_class_diagram_for_googleap_20" ismap="ismap" class="graph-without-title" />
</center>
@@ -254,7 +254,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html b/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html
index 6aaa4a1..921d2f9 100644
--- a/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html
+++ b/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html
@@ -59,24 +59,24 @@
<h1 class="epydoc">Class UnknownApiNameOrVersion</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#UnknownApiNameOrVersion">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_21" name="uml_class_diagram_for_googleap_21">
-<area shape="rect" id="node1" href="googleapiclient.errors.UnknownApiNameOrVersion-class.html" title="No API with that name and version exists." alt="" coords="5,435,199,477"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="77,373,130,416"/>
-<area shape="rect" id="node3_14" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="41,311,166,329"/>
-<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="41,329,166,348"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="29,280,178,355"/>
-<area shape="rect" id="node4_16" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="25,28,181,47"/>
-<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="25,47,181,65"/>
-<area shape="rect" id="node4_18" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="25,68,181,87"/>
-<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="25,87,181,105"/>
-<area shape="rect" id="node4_20" href="javascript:void(0);" title="x[y]" alt="" coords="25,105,181,124"/>
-<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[i:j]" alt="" coords="25,124,181,143"/>
-<area shape="rect" id="node4_22" href="javascript:void(0);" title="helper for pickle" alt="" coords="25,143,181,161"/>
-<area shape="rect" id="node4_23" href="javascript:void(0);" title="repr(x)" alt="" coords="25,161,181,180"/>
-<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="25,180,181,199"/>
-<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="25,199,181,217"/>
-<area shape="rect" id="node4_26" href="javascript:void(0);" title="str(x)" alt="" coords="25,217,181,236"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="25,236,181,255"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="12,5,192,261"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.UnknownApiNameOrVersion-class.html" title="No API with that name and version exists." alt="" coords="5,461,198,507"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="74,397,129,443"/>
+<area shape="rect" id="node3_14" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="24,31,181,51"/>
+<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="24,51,181,71"/>
+<area shape="rect" id="node3_16" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="24,73,181,93"/>
+<area shape="rect" id="node3_17" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="24,93,181,113"/>
+<area shape="rect" id="node3_18" href="javascript:void(0);" title="x[y]" alt="" coords="24,113,181,133"/>
+<area shape="rect" id="node3_19" href="javascript:void(0);" title="x[i:j]" alt="" coords="24,133,181,153"/>
+<area shape="rect" id="node3_20" href="javascript:void(0);" title="helper for pickle" alt="" coords="24,153,181,173"/>
+<area shape="rect" id="node3_21" href="javascript:void(0);" title="repr(x)" alt="" coords="24,173,181,193"/>
+<area shape="rect" id="node3_22" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="24,193,181,213"/>
+<area shape="rect" id="node3_23" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="24,213,181,233"/>
+<area shape="rect" id="node3_24" href="javascript:void(0);" title="str(x)" alt="" coords="24,233,181,253"/>
+<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="24,253,181,273"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="12,5,193,280"/>
+<area shape="rect" id="node4_26" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="39,332,165,352"/>
+<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="39,352,165,372"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="26,299,177,379"/>
</map>
<img src="uml_class_diagram_for_googleap_21.gif" alt='' usemap="#uml_class_diagram_for_googleap_21" ismap="ismap" class="graph-without-title" />
</center>
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.UnknownFileType-class.html b/docs/epy/googleapiclient.errors.UnknownFileType-class.html
index 8910e0b..ffb9997 100644
--- a/docs/epy/googleapiclient.errors.UnknownFileType-class.html
+++ b/docs/epy/googleapiclient.errors.UnknownFileType-class.html
@@ -59,24 +59,24 @@
<h1 class="epydoc">Class UnknownFileType</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#UnknownFileType">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_22" name="uml_class_diagram_for_googleap_22">
-<area shape="rect" id="node1" href="googleapiclient.errors.UnknownFileType-class.html" title="File type unknown or unexpected." alt="" coords="31,435,160,477"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="70,373,123,416"/>
-<area shape="rect" id="node3_14" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="34,311,159,329"/>
-<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="34,329,159,348"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="22,280,171,355"/>
-<area shape="rect" id="node4_16" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="18,28,174,47"/>
-<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="18,47,174,65"/>
-<area shape="rect" id="node4_18" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="18,68,174,87"/>
-<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="18,87,174,105"/>
-<area shape="rect" id="node4_20" href="javascript:void(0);" title="x[y]" alt="" coords="18,105,174,124"/>
-<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[i:j]" alt="" coords="18,124,174,143"/>
-<area shape="rect" id="node4_22" href="javascript:void(0);" title="helper for pickle" alt="" coords="18,143,174,161"/>
-<area shape="rect" id="node4_23" href="javascript:void(0);" title="repr(x)" alt="" coords="18,161,174,180"/>
-<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="18,180,174,199"/>
-<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="18,199,174,217"/>
-<area shape="rect" id="node4_26" href="javascript:void(0);" title="str(x)" alt="" coords="18,217,174,236"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="18,236,174,255"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,185,261"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.UnknownFileType-class.html" title="File type unknown or unexpected." alt="" coords="31,461,161,507"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="67,397,122,443"/>
+<area shape="rect" id="node3_14" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="17,31,175,51"/>
+<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="17,51,175,71"/>
+<area shape="rect" id="node3_16" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="17,73,175,93"/>
+<area shape="rect" id="node3_17" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="17,93,175,113"/>
+<area shape="rect" id="node3_18" href="javascript:void(0);" title="x[y]" alt="" coords="17,113,175,133"/>
+<area shape="rect" id="node3_19" href="javascript:void(0);" title="x[i:j]" alt="" coords="17,133,175,153"/>
+<area shape="rect" id="node3_20" href="javascript:void(0);" title="helper for pickle" alt="" coords="17,153,175,173"/>
+<area shape="rect" id="node3_21" href="javascript:void(0);" title="repr(x)" alt="" coords="17,173,175,193"/>
+<area shape="rect" id="node3_22" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="17,193,175,213"/>
+<area shape="rect" id="node3_23" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="17,213,175,233"/>
+<area shape="rect" id="node3_24" href="javascript:void(0);" title="str(x)" alt="" coords="17,233,175,253"/>
+<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="17,253,175,273"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,187,280"/>
+<area shape="rect" id="node4_26" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="32,332,159,352"/>
+<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="32,352,159,372"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="19,299,170,379"/>
</map>
<img src="uml_class_diagram_for_googleap_22.gif" alt='' usemap="#uml_class_diagram_for_googleap_22" ismap="ismap" class="graph-without-title" />
</center>
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.UnknownLinkType-class.html b/docs/epy/googleapiclient.errors.UnknownLinkType-class.html
index b75ee7b..a3e472b 100644
--- a/docs/epy/googleapiclient.errors.UnknownLinkType-class.html
+++ b/docs/epy/googleapiclient.errors.UnknownLinkType-class.html
@@ -59,24 +59,24 @@
<h1 class="epydoc">Class UnknownLinkType</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.errors-pysrc.html#UnknownLinkType">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_23" name="uml_class_diagram_for_googleap_23">
-<area shape="rect" id="node1" href="googleapiclient.errors.UnknownLinkType-class.html" title="Link type unknown or unexpected." alt="" coords="29,435,161,477"/>
-<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="70,373,123,416"/>
-<area shape="rect" id="node3_14" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="34,311,159,329"/>
-<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="34,329,159,348"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="22,280,171,355"/>
-<area shape="rect" id="node4_16" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="18,28,174,47"/>
-<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="18,47,174,65"/>
-<area shape="rect" id="node4_18" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="18,68,174,87"/>
-<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="18,87,174,105"/>
-<area shape="rect" id="node4_20" href="javascript:void(0);" title="x[y]" alt="" coords="18,105,174,124"/>
-<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[i:j]" alt="" coords="18,124,174,143"/>
-<area shape="rect" id="node4_22" href="javascript:void(0);" title="helper for pickle" alt="" coords="18,143,174,161"/>
-<area shape="rect" id="node4_23" href="javascript:void(0);" title="repr(x)" alt="" coords="18,161,174,180"/>
-<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="18,180,174,199"/>
-<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="18,199,174,217"/>
-<area shape="rect" id="node4_26" href="javascript:void(0);" title="str(x)" alt="" coords="18,217,174,236"/>
-<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="18,236,174,255"/>
-<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,185,261"/>
+<area shape="rect" id="node1" href="googleapiclient.errors.UnknownLinkType-class.html" title="Link type unknown or unexpected." alt="" coords="27,461,162,507"/>
+<area shape="rect" id="node2" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="67,397,122,443"/>
+<area shape="rect" id="node3_14" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="17,31,175,51"/>
+<area shape="rect" id="node3_15" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="17,51,175,71"/>
+<area shape="rect" id="node3_16" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="17,73,175,93"/>
+<area shape="rect" id="node3_17" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="17,93,175,113"/>
+<area shape="rect" id="node3_18" href="javascript:void(0);" title="x[y]" alt="" coords="17,113,175,133"/>
+<area shape="rect" id="node3_19" href="javascript:void(0);" title="x[i:j]" alt="" coords="17,133,175,153"/>
+<area shape="rect" id="node3_20" href="javascript:void(0);" title="helper for pickle" alt="" coords="17,153,175,173"/>
+<area shape="rect" id="node3_21" href="javascript:void(0);" title="repr(x)" alt="" coords="17,173,175,193"/>
+<area shape="rect" id="node3_22" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="17,193,175,213"/>
+<area shape="rect" id="node3_23" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="17,213,175,233"/>
+<area shape="rect" id="node3_24" href="javascript:void(0);" title="str(x)" alt="" coords="17,233,175,253"/>
+<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="17,253,175,273"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="5,5,187,280"/>
+<area shape="rect" id="node4_26" href="javascript:void(0);" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="32,332,159,352"/>
+<area shape="rect" id="node4_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="32,352,159,372"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="19,299,170,379"/>
</map>
<img src="uml_class_diagram_for_googleap_23.gif" alt='' usemap="#uml_class_diagram_for_googleap_23" ismap="ismap" class="graph-without-title" />
</center>
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http-module.html b/docs/epy/googleapiclient.http-module.html
index e4ef43a..8bee14d 100644
--- a/docs/epy/googleapiclient.http-module.html
+++ b/docs/epy/googleapiclient.http-module.html
@@ -544,7 +544,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http-pysrc.html b/docs/epy/googleapiclient.http-pysrc.html
index f048d04..c5193fa 100644
--- a/docs/epy/googleapiclient.http-pysrc.html
+++ b/docs/epy/googleapiclient.http-pysrc.html
@@ -2164,7 +2164,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.BatchHttpRequest-class.html b/docs/epy/googleapiclient.http.BatchHttpRequest-class.html
index cf8f467..ba4004a 100644
--- a/docs/epy/googleapiclient.http.BatchHttpRequest-class.html
+++ b/docs/epy/googleapiclient.http.BatchHttpRequest-class.html
@@ -59,10 +59,10 @@
<h1 class="epydoc">Class BatchHttpRequest</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_24" name="uml_class_diagram_for_googleap_24">
-<area shape="rect" id="node1_3" href="googleapiclient.http.BatchHttpRequest-class.html#__init__" title="Constructor for a BatchHttpRequest." alt="" coords="18,36,331,55"/>
-<area shape="rect" id="node1_4" href="googleapiclient.http.BatchHttpRequest-class.html#add" title="Add a new request." alt="" coords="18,55,331,73"/>
-<area shape="rect" id="node1_5" href="googleapiclient.http.BatchHttpRequest-class.html#execute" title="Execute all the requests as a single batched HTTP request." alt="" coords="18,73,331,92"/>
-<area shape="rect" id="node1" href="googleapiclient.http.BatchHttpRequest-class.html" title="Batches multiple HttpRequest objects into a single HTTP request." alt="" coords="5,5,343,99"/>
+<area shape="rect" id="node1_3" href="googleapiclient.http.BatchHttpRequest-class.html#__init__" title="Constructor for a BatchHttpRequest." alt="" coords="17,40,328,60"/>
+<area shape="rect" id="node1_4" href="googleapiclient.http.BatchHttpRequest-class.html#add" title="Add a new request." alt="" coords="17,60,328,80"/>
+<area shape="rect" id="node1_5" href="googleapiclient.http.BatchHttpRequest-class.html#execute" title="Execute all the requests as a single batched HTTP request." alt="" coords="17,80,328,100"/>
+<area shape="rect" id="node1" href="googleapiclient.http.BatchHttpRequest-class.html" title="Batches multiple HttpRequest objects into a single HTTP request." alt="" coords="5,6,339,106"/>
</map>
<img src="uml_class_diagram_for_googleap_24.gif" alt='' usemap="#uml_class_diagram_for_googleap_24" ismap="ismap" class="graph-without-title" />
</center>
@@ -740,7 +740,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.HttpMock-class.html b/docs/epy/googleapiclient.http.HttpMock-class.html
index 2904d10..41aa061 100644
--- a/docs/epy/googleapiclient.http.HttpMock-class.html
+++ b/docs/epy/googleapiclient.http.HttpMock-class.html
@@ -59,9 +59,9 @@
<h1 class="epydoc">Class HttpMock</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpMock">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_25" name="uml_class_diagram_for_googleap_25">
-<area shape="rect" id="node1_2" href="googleapiclient.http.HttpMock-class.html#__init__" title="Args:..." alt="" coords="17,36,617,55"/>
-<area shape="rect" id="node1_3" href="googleapiclient.http.HttpMock-class.html#request" title="googleapiclient.http.HttpMock.request" alt="" coords="17,55,617,73"/>
-<area shape="rect" id="node1" href="googleapiclient.http.HttpMock-class.html" title="Mock of httplib2.Http" alt="" coords="5,5,629,80"/>
+<area shape="rect" id="node1_2" href="googleapiclient.http.HttpMock-class.html#__init__" title="Args:..." alt="" coords="17,39,611,59"/>
+<area shape="rect" id="node1_3" href="googleapiclient.http.HttpMock-class.html#request" title="googleapiclient.http.HttpMock.request" alt="" coords="17,59,611,79"/>
+<area shape="rect" id="node1" href="googleapiclient.http.HttpMock-class.html" title="Mock of httplib2.Http" alt="" coords="5,5,622,85"/>
</map>
<img src="uml_class_diagram_for_googleap_25.gif" alt='' usemap="#uml_class_diagram_for_googleap_25" ismap="ismap" class="graph-without-title" />
</center>
@@ -250,7 +250,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.HttpMockSequence-class.html b/docs/epy/googleapiclient.http.HttpMockSequence-class.html
index 6acca4f..ed9ff1a 100644
--- a/docs/epy/googleapiclient.http.HttpMockSequence-class.html
+++ b/docs/epy/googleapiclient.http.HttpMockSequence-class.html
@@ -59,9 +59,9 @@
<h1 class="epydoc">Class HttpMockSequence</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpMockSequence">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_26" name="uml_class_diagram_for_googleap_26">
-<area shape="rect" id="node1_2" href="googleapiclient.http.HttpMockSequence-class.html#__init__" title="Args:..." alt="" coords="17,36,617,55"/>
-<area shape="rect" id="node1_3" href="googleapiclient.http.HttpMockSequence-class.html#request" title="googleapiclient.http.HttpMockSequence.request" alt="" coords="17,55,617,73"/>
-<area shape="rect" id="node1" href="googleapiclient.http.HttpMockSequence-class.html" title="Mock of httplib2.Http" alt="" coords="5,5,629,80"/>
+<area shape="rect" id="node1_2" href="googleapiclient.http.HttpMockSequence-class.html#__init__" title="Args:..." alt="" coords="17,39,611,59"/>
+<area shape="rect" id="node1_3" href="googleapiclient.http.HttpMockSequence-class.html#request" title="googleapiclient.http.HttpMockSequence.request" alt="" coords="17,59,611,79"/>
+<area shape="rect" id="node1" href="googleapiclient.http.HttpMockSequence-class.html" title="Mock of httplib2.Http" alt="" coords="5,5,622,85"/>
</map>
<img src="uml_class_diagram_for_googleap_26.gif" alt='' usemap="#uml_class_diagram_for_googleap_26" ismap="ismap" class="graph-without-title" />
</center>
@@ -267,7 +267,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.HttpRequest-class.html b/docs/epy/googleapiclient.http.HttpRequest-class.html
index bea118c..852f863 100644
--- a/docs/epy/googleapiclient.http.HttpRequest-class.html
+++ b/docs/epy/googleapiclient.http.HttpRequest-class.html
@@ -59,13 +59,13 @@
<h1 class="epydoc">Class HttpRequest</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpRequest">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_27" name="uml_class_diagram_for_googleap_27">
-<area shape="rect" id="node1_6" href="googleapiclient.http.HttpRequest-class.html#__init__" title="Constructor for an HttpRequest." alt="" coords="17,36,684,55"/>
-<area shape="rect" id="node1_7" href="googleapiclient.http.HttpRequest-class.html#execute" title="Execute the request." alt="" coords="17,55,684,73"/>
-<area shape="rect" id="node1_8" href="googleapiclient.http.HttpRequest-class.html#add_response_callback" title="add_response_headers_callback" alt="" coords="17,73,684,92"/>
-<area shape="rect" id="node1_9" href="googleapiclient.http.HttpRequest-class.html#next_chunk" title="Execute the next step of a resumable upload." alt="" coords="17,92,684,111"/>
-<area shape="rect" id="node1_10" href="googleapiclient.http.HttpRequest-class.html#to_json" title="Returns a JSON representation of the HttpRequest." alt="" coords="17,111,684,129"/>
-<area shape="rect" id="node1_11" href="googleapiclient.http.HttpRequest-class.html#from_json" title="Returns an HttpRequest populated with info from a JSON object." alt="" coords="17,129,684,148"/>
-<area shape="rect" id="node1" href="googleapiclient.http.HttpRequest-class.html" title="Encapsulates a single HTTP request." alt="" coords="5,5,696,155"/>
+<area shape="rect" id="node1_6" href="googleapiclient.http.HttpRequest-class.html#__init__" title="Constructor for an HttpRequest." alt="" coords="17,39,677,59"/>
+<area shape="rect" id="node1_7" href="googleapiclient.http.HttpRequest-class.html#execute" title="Execute the request." alt="" coords="17,59,677,79"/>
+<area shape="rect" id="node1_8" href="googleapiclient.http.HttpRequest-class.html#add_response_callback" title="add_response_headers_callback" alt="" coords="17,79,677,99"/>
+<area shape="rect" id="node1_9" href="googleapiclient.http.HttpRequest-class.html#next_chunk" title="Execute the next step of a resumable upload." alt="" coords="17,99,677,119"/>
+<area shape="rect" id="node1_10" href="googleapiclient.http.HttpRequest-class.html#to_json" title="Returns a JSON representation of the HttpRequest." alt="" coords="17,119,677,139"/>
+<area shape="rect" id="node1_11" href="googleapiclient.http.HttpRequest-class.html#from_json" title="Returns an HttpRequest populated with info from a JSON object." alt="" coords="17,139,677,159"/>
+<area shape="rect" id="node1" href="googleapiclient.http.HttpRequest-class.html" title="Encapsulates a single HTTP request." alt="" coords="5,5,689,165"/>
</map>
<img src="uml_class_diagram_for_googleap_27.gif" alt='' usemap="#uml_class_diagram_for_googleap_27" ismap="ismap" class="graph-without-title" />
</center>
@@ -561,7 +561,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.HttpRequestMock-class.html b/docs/epy/googleapiclient.http.HttpRequestMock-class.html
index 5a9023f..2d3cf46 100644
--- a/docs/epy/googleapiclient.http.HttpRequestMock-class.html
+++ b/docs/epy/googleapiclient.http.HttpRequestMock-class.html
@@ -59,9 +59,9 @@
<h1 class="epydoc">Class HttpRequestMock</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpRequestMock">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_28" name="uml_class_diagram_for_googleap_28">
-<area shape="rect" id="node1_2" href="googleapiclient.http.HttpRequestMock-class.html#__init__" title="Constructor for HttpRequestMock" alt="" coords="17,36,241,55"/>
-<area shape="rect" id="node1_3" href="googleapiclient.http.HttpRequestMock-class.html#execute" title="Execute the request." alt="" coords="17,55,241,73"/>
-<area shape="rect" id="node1" href="googleapiclient.http.HttpRequestMock-class.html" title="Mock of HttpRequest." alt="" coords="5,5,253,80"/>
+<area shape="rect" id="node1_2" href="googleapiclient.http.HttpRequestMock-class.html#__init__" title="Constructor for HttpRequestMock" alt="" coords="16,39,240,59"/>
+<area shape="rect" id="node1_3" href="googleapiclient.http.HttpRequestMock-class.html#execute" title="Execute the request." alt="" coords="16,59,240,79"/>
+<area shape="rect" id="node1" href="googleapiclient.http.HttpRequestMock-class.html" title="Mock of HttpRequest." alt="" coords="4,5,252,85"/>
</map>
<img src="uml_class_diagram_for_googleap_28.gif" alt='' usemap="#uml_class_diagram_for_googleap_28" ismap="ismap" class="graph-without-title" />
</center>
@@ -279,7 +279,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html b/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html
index a4fd9c3..e4d5a42 100644
--- a/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html
+++ b/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html
@@ -59,9 +59,9 @@
<h1 class="epydoc">Class MediaDownloadProgress</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaDownloadProgress">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_29" name="uml_class_diagram_for_googleap_29">
-<area shape="rect" id="node1_2" href="googleapiclient.http.MediaDownloadProgress-class.html#__init__" title="Constructor." alt="" coords="18,36,291,55"/>
-<area shape="rect" id="node1_3" href="googleapiclient.http.MediaDownloadProgress-class.html#progress" title="Percent of download completed, as a float." alt="" coords="18,55,291,73"/>
-<area shape="rect" id="node1" href="googleapiclient.http.MediaDownloadProgress-class.html" title="Status of a resumable download." alt="" coords="5,5,303,80"/>
+<area shape="rect" id="node1_2" href="googleapiclient.http.MediaDownloadProgress-class.html#__init__" title="Constructor." alt="" coords="17,39,288,59"/>
+<area shape="rect" id="node1_3" href="googleapiclient.http.MediaDownloadProgress-class.html#progress" title="Percent of download completed, as a float." alt="" coords="17,59,288,79"/>
+<area shape="rect" id="node1" href="googleapiclient.http.MediaDownloadProgress-class.html" title="Status of a resumable download." alt="" coords="5,5,299,85"/>
</map>
<img src="uml_class_diagram_for_googleap_29.gif" alt='' usemap="#uml_class_diagram_for_googleap_29" ismap="ismap" class="graph-without-title" />
</center>
@@ -272,7 +272,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaFileUpload-class.html b/docs/epy/googleapiclient.http.MediaFileUpload-class.html
index 801cda2..e143457 100644
--- a/docs/epy/googleapiclient.http.MediaFileUpload-class.html
+++ b/docs/epy/googleapiclient.http.MediaFileUpload-class.html
@@ -59,20 +59,20 @@
<h1 class="epydoc">Class MediaFileUpload</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaFileUpload">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_30" name="uml_class_diagram_for_googleap_30">
-<area shape="rect" id="node1_11" href="googleapiclient.http.MediaFileUpload-class.html#__init__" title="Constructor." alt="" coords="17,297,596,316"/>
-<area shape="rect" id="node1_12" href="googleapiclient.http.MediaFileUpload-class.html#to_json" title="Creating a JSON representation of an instance of MediaFileUpload." alt="" coords="17,316,596,335"/>
-<area shape="rect" id="node1_13" href="googleapiclient.http.MediaFileUpload-class.html#from_json" title="googleapiclient.http.MediaFileUpload.from_json" alt="" coords="17,335,596,353"/>
-<area shape="rect" id="node1" href="googleapiclient.http.MediaFileUpload-class.html" title="A MediaUpload for a file." alt="" coords="5,267,608,360"/>
-<area shape="rect" id="node2_14" href="googleapiclient.http.MediaIoBaseUpload-class.html#chunksize" title="Chunk size for resumable uploads." alt="" coords="223,111,391,129"/>
-<area shape="rect" id="node2_15" href="googleapiclient.http.MediaIoBaseUpload-class.html#mimetype" title="Mime type of the body." alt="" coords="223,129,391,148"/>
-<area shape="rect" id="node2_16" href="googleapiclient.http.MediaIoBaseUpload-class.html#size" title="Size of upload." alt="" coords="223,148,391,167"/>
-<area shape="rect" id="node2_17" href="googleapiclient.http.MediaIoBaseUpload-class.html#resumable" title="Whether this upload is resumable." alt="" coords="223,167,391,185"/>
-<area shape="rect" id="node2_18" href="googleapiclient.http.MediaIoBaseUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="223,185,391,204"/>
-<area shape="rect" id="node2_19" href="googleapiclient.http.MediaIoBaseUpload-class.html#has_stream" title="Does the underlying upload support a streaming interface." alt="" coords="223,204,391,223"/>
-<area shape="rect" id="node2_20" href="googleapiclient.http.MediaIoBaseUpload-class.html#stream" title="A stream interface to the data being uploaded." alt="" coords="223,223,391,241"/>
-<area shape="rect" id="node2" href="googleapiclient.http.MediaIoBaseUpload-class.html" title="A MediaUpload for a io.Base objects." alt="" coords="211,80,403,248"/>
-<area shape="rect" id="node3_21" href="googleapiclient.http.MediaUpload-class.html#new_from_json" title="Utility class method to instantiate a MediaUpload subclass from a JSON representation produced by to_json()." alt="" coords="239,36,373,55"/>
-<area shape="rect" id="node3" href="googleapiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="226,5,385,61"/>
+<area shape="rect" id="node1_11" href="googleapiclient.http.MediaFileUpload-class.html#__init__" title="Constructor." alt="" coords="17,320,597,340"/>
+<area shape="rect" id="node1_12" href="googleapiclient.http.MediaFileUpload-class.html#to_json" title="Creating a JSON representation of an instance of MediaFileUpload." alt="" coords="17,340,597,360"/>
+<area shape="rect" id="node1_13" href="googleapiclient.http.MediaFileUpload-class.html#from_json" title="googleapiclient.http.MediaFileUpload.from_json" alt="" coords="17,360,597,380"/>
+<area shape="rect" id="node1" href="googleapiclient.http.MediaFileUpload-class.html" title="A MediaUpload for a file." alt="" coords="5,286,609,386"/>
+<area shape="rect" id="node2_14" href="googleapiclient.http.MediaIoBaseUpload-class.html#chunksize" title="Chunk size for resumable uploads." alt="" coords="224,120,392,140"/>
+<area shape="rect" id="node2_15" href="googleapiclient.http.MediaIoBaseUpload-class.html#mimetype" title="Mime type of the body." alt="" coords="224,140,392,160"/>
+<area shape="rect" id="node2_16" href="googleapiclient.http.MediaIoBaseUpload-class.html#size" title="Size of upload." alt="" coords="224,160,392,180"/>
+<area shape="rect" id="node2_17" href="googleapiclient.http.MediaIoBaseUpload-class.html#resumable" title="Whether this upload is resumable." alt="" coords="224,180,392,200"/>
+<area shape="rect" id="node2_18" href="googleapiclient.http.MediaIoBaseUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="224,200,392,220"/>
+<area shape="rect" id="node2_19" href="googleapiclient.http.MediaIoBaseUpload-class.html#has_stream" title="Does the underlying upload support a streaming interface." alt="" coords="224,220,392,240"/>
+<area shape="rect" id="node2_20" href="googleapiclient.http.MediaIoBaseUpload-class.html#stream" title="A stream interface to the data being uploaded." alt="" coords="224,240,392,260"/>
+<area shape="rect" id="node2" href="googleapiclient.http.MediaIoBaseUpload-class.html" title="A MediaUpload for a io.Base objects." alt="" coords="212,86,404,266"/>
+<area shape="rect" id="node3_21" href="googleapiclient.http.MediaUpload-class.html#new_from_json" title="Utility class method to instantiate a MediaUpload subclass from a JSON representation produced by to_json()." alt="" coords="240,40,376,60"/>
+<area shape="rect" id="node3" href="googleapiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="228,6,388,66"/>
</map>
<img src="uml_class_diagram_for_googleap_30.gif" alt='' usemap="#uml_class_diagram_for_googleap_30" ismap="ismap" class="graph-without-title" />
</center>
@@ -392,7 +392,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html b/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html
index df1ab66..06f86ba 100644
--- a/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html
+++ b/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html
@@ -59,19 +59,19 @@
<h1 class="epydoc">Class MediaInMemoryUpload</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaInMemoryUpload">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_31" name="uml_class_diagram_for_googleap_31">
-<area shape="rect" id="node1_10" href="googleapiclient.http.MediaInMemoryUpload-class.html#__init__" title="Create a new MediaInMemoryUpload." alt="" coords="17,316,689,335"/>
-<area shape="rect" id="node1" href="googleapiclient.http.MediaInMemoryUpload-class.html" title="MediaUpload for a chunk of bytes." alt="" coords="5,285,701,341"/>
-<area shape="rect" id="node2_11" href="googleapiclient.http.MediaIoBaseUpload-class.html#chunksize" title="Chunk size for resumable uploads." alt="" coords="269,111,437,129"/>
-<area shape="rect" id="node2_12" href="googleapiclient.http.MediaIoBaseUpload-class.html#mimetype" title="Mime type of the body." alt="" coords="269,129,437,148"/>
-<area shape="rect" id="node2_13" href="googleapiclient.http.MediaIoBaseUpload-class.html#size" title="Size of upload." alt="" coords="269,148,437,167"/>
-<area shape="rect" id="node2_14" href="googleapiclient.http.MediaIoBaseUpload-class.html#resumable" title="Whether this upload is resumable." alt="" coords="269,167,437,185"/>
-<area shape="rect" id="node2_15" href="googleapiclient.http.MediaIoBaseUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="269,185,437,204"/>
-<area shape="rect" id="node2_16" href="googleapiclient.http.MediaIoBaseUpload-class.html#has_stream" title="Does the underlying upload support a streaming interface." alt="" coords="269,204,437,223"/>
-<area shape="rect" id="node2_17" href="googleapiclient.http.MediaIoBaseUpload-class.html#stream" title="A stream interface to the data being uploaded." alt="" coords="269,223,437,241"/>
-<area shape="rect" id="node2_18" href="googleapiclient.http.MediaIoBaseUpload-class.html#to_json" title="This upload type is not serializable." alt="" coords="269,241,437,260"/>
-<area shape="rect" id="node2" href="googleapiclient.http.MediaIoBaseUpload-class.html" title="A MediaUpload for a io.Base objects." alt="" coords="257,80,449,267"/>
-<area shape="rect" id="node3_19" href="googleapiclient.http.MediaUpload-class.html#new_from_json" title="Utility class method to instantiate a MediaUpload subclass from a JSON representation produced by to_json()." alt="" coords="285,36,420,55"/>
-<area shape="rect" id="node3" href="googleapiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="273,5,431,61"/>
+<area shape="rect" id="node1_10" href="googleapiclient.http.MediaInMemoryUpload-class.html#__init__" title="Create a new MediaInMemoryUpload." alt="" coords="17,339,689,359"/>
+<area shape="rect" id="node1" href="googleapiclient.http.MediaInMemoryUpload-class.html" title="MediaUpload for a chunk of bytes." alt="" coords="5,305,701,365"/>
+<area shape="rect" id="node2_11" href="googleapiclient.http.MediaIoBaseUpload-class.html#chunksize" title="Chunk size for resumable uploads." alt="" coords="269,119,437,139"/>
+<area shape="rect" id="node2_12" href="googleapiclient.http.MediaIoBaseUpload-class.html#mimetype" title="Mime type of the body." alt="" coords="269,139,437,159"/>
+<area shape="rect" id="node2_13" href="googleapiclient.http.MediaIoBaseUpload-class.html#size" title="Size of upload." alt="" coords="269,159,437,179"/>
+<area shape="rect" id="node2_14" href="googleapiclient.http.MediaIoBaseUpload-class.html#resumable" title="Whether this upload is resumable." alt="" coords="269,179,437,199"/>
+<area shape="rect" id="node2_15" href="googleapiclient.http.MediaIoBaseUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="269,199,437,219"/>
+<area shape="rect" id="node2_16" href="googleapiclient.http.MediaIoBaseUpload-class.html#has_stream" title="Does the underlying upload support a streaming interface." alt="" coords="269,219,437,239"/>
+<area shape="rect" id="node2_17" href="googleapiclient.http.MediaIoBaseUpload-class.html#stream" title="A stream interface to the data being uploaded." alt="" coords="269,239,437,259"/>
+<area shape="rect" id="node2_18" href="googleapiclient.http.MediaIoBaseUpload-class.html#to_json" title="This upload type is not serializable." alt="" coords="269,259,437,279"/>
+<area shape="rect" id="node2" href="googleapiclient.http.MediaIoBaseUpload-class.html" title="A MediaUpload for a io.Base objects." alt="" coords="257,85,449,285"/>
+<area shape="rect" id="node3_19" href="googleapiclient.http.MediaUpload-class.html#new_from_json" title="Utility class method to instantiate a MediaUpload subclass from a JSON representation produced by to_json()." alt="" coords="285,40,421,60"/>
+<area shape="rect" id="node3" href="googleapiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="273,6,433,66"/>
</map>
<img src="uml_class_diagram_for_googleap_31.gif" alt='' usemap="#uml_class_diagram_for_googleap_31" ismap="ismap" class="graph-without-title" />
</center>
@@ -297,7 +297,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html b/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html
index eb99067..8299529 100644
--- a/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html
+++ b/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html
@@ -59,9 +59,9 @@
<h1 class="epydoc">Class MediaIoBaseDownload</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaIoBaseDownload">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_32" name="uml_class_diagram_for_googleap_32">
-<area shape="rect" id="node1_2" href="googleapiclient.http.MediaIoBaseDownload-class.html#__init__" title="Constructor." alt="" coords="18,36,395,55"/>
-<area shape="rect" id="node1_3" href="googleapiclient.http.MediaIoBaseDownload-class.html#next_chunk" title="Get the next chunk of the download." alt="" coords="18,55,395,73"/>
-<area shape="rect" id="node1" href="googleapiclient.http.MediaIoBaseDownload-class.html" title=""Download media resources." alt="" coords="5,5,407,80"/>
+<area shape="rect" id="node1_2" href="googleapiclient.http.MediaIoBaseDownload-class.html#__init__" title="Constructor." alt="" coords="17,39,397,59"/>
+<area shape="rect" id="node1_3" href="googleapiclient.http.MediaIoBaseDownload-class.html#next_chunk" title="Get the next chunk of the download." alt="" coords="17,59,397,79"/>
+<area shape="rect" id="node1" href="googleapiclient.http.MediaIoBaseDownload-class.html" title=""Download media resources." alt="" coords="5,5,409,85"/>
</map>
<img src="uml_class_diagram_for_googleap_32.gif" alt='' usemap="#uml_class_diagram_for_googleap_32" ismap="ismap" class="graph-without-title" />
</center>
@@ -314,7 +314,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html b/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html
index 834c006..9c4df3e 100644
--- a/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html
+++ b/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html
@@ -59,18 +59,18 @@
<h1 class="epydoc">Class MediaIoBaseUpload</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaIoBaseUpload">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_33" name="uml_class_diagram_for_googleap_33">
-<area shape="rect" id="node1_10" href="googleapiclient.http.MediaIoBaseUpload-class.html#__init__" title="Constructor." alt="" coords="18,111,518,129"/>
-<area shape="rect" id="node1_11" href="googleapiclient.http.MediaIoBaseUpload-class.html#chunksize" title="Chunk size for resumable uploads." alt="" coords="18,129,518,148"/>
-<area shape="rect" id="node1_12" href="googleapiclient.http.MediaIoBaseUpload-class.html#mimetype" title="Mime type of the body." alt="" coords="18,148,518,167"/>
-<area shape="rect" id="node1_13" href="googleapiclient.http.MediaIoBaseUpload-class.html#size" title="Size of upload." alt="" coords="18,167,518,185"/>
-<area shape="rect" id="node1_14" href="googleapiclient.http.MediaIoBaseUpload-class.html#resumable" title="Whether this upload is resumable." alt="" coords="18,185,518,204"/>
-<area shape="rect" id="node1_15" href="googleapiclient.http.MediaIoBaseUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="18,204,518,223"/>
-<area shape="rect" id="node1_16" href="googleapiclient.http.MediaIoBaseUpload-class.html#has_stream" title="Does the underlying upload support a streaming interface." alt="" coords="18,223,518,241"/>
-<area shape="rect" id="node1_17" href="googleapiclient.http.MediaIoBaseUpload-class.html#stream" title="A stream interface to the data being uploaded." alt="" coords="18,241,518,260"/>
-<area shape="rect" id="node1_18" href="googleapiclient.http.MediaIoBaseUpload-class.html#to_json" title="This upload type is not serializable." alt="" coords="18,260,518,279"/>
-<area shape="rect" id="node1" href="googleapiclient.http.MediaIoBaseUpload-class.html" title="A MediaUpload for a io.Base objects." alt="" coords="5,80,529,285"/>
-<area shape="rect" id="node2_19" href="googleapiclient.http.MediaUpload-class.html#new_from_json" title="Utility class method to instantiate a MediaUpload subclass from a JSON representation produced by to_json()." alt="" coords="201,36,335,55"/>
-<area shape="rect" id="node2" href="googleapiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="188,5,347,61"/>
+<area shape="rect" id="node1_10" href="googleapiclient.http.MediaIoBaseUpload-class.html#__init__" title="Constructor." alt="" coords="17,120,520,140"/>
+<area shape="rect" id="node1_11" href="googleapiclient.http.MediaIoBaseUpload-class.html#chunksize" title="Chunk size for resumable uploads." alt="" coords="17,140,520,160"/>
+<area shape="rect" id="node1_12" href="googleapiclient.http.MediaIoBaseUpload-class.html#mimetype" title="Mime type of the body." alt="" coords="17,160,520,180"/>
+<area shape="rect" id="node1_13" href="googleapiclient.http.MediaIoBaseUpload-class.html#size" title="Size of upload." alt="" coords="17,180,520,200"/>
+<area shape="rect" id="node1_14" href="googleapiclient.http.MediaIoBaseUpload-class.html#resumable" title="Whether this upload is resumable." alt="" coords="17,200,520,220"/>
+<area shape="rect" id="node1_15" href="googleapiclient.http.MediaIoBaseUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="17,220,520,240"/>
+<area shape="rect" id="node1_16" href="googleapiclient.http.MediaIoBaseUpload-class.html#has_stream" title="Does the underlying upload support a streaming interface." alt="" coords="17,240,520,260"/>
+<area shape="rect" id="node1_17" href="googleapiclient.http.MediaIoBaseUpload-class.html#stream" title="A stream interface to the data being uploaded." alt="" coords="17,260,520,280"/>
+<area shape="rect" id="node1_18" href="googleapiclient.http.MediaIoBaseUpload-class.html#to_json" title="This upload type is not serializable." alt="" coords="17,280,520,300"/>
+<area shape="rect" id="node1" href="googleapiclient.http.MediaIoBaseUpload-class.html" title="A MediaUpload for a io.Base objects." alt="" coords="5,86,531,306"/>
+<area shape="rect" id="node2_19" href="googleapiclient.http.MediaUpload-class.html#new_from_json" title="Utility class method to instantiate a MediaUpload subclass from a JSON representation produced by to_json()." alt="" coords="201,40,337,60"/>
+<area shape="rect" id="node2" href="googleapiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="189,6,349,66"/>
</map>
<img src="uml_class_diagram_for_googleap_33.gif" alt='' usemap="#uml_class_diagram_for_googleap_33" ismap="ismap" class="graph-without-title" />
</center>
@@ -674,7 +674,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:06 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaUpload-class.html b/docs/epy/googleapiclient.http.MediaUpload-class.html
index 2b583fd..aeca13f 100644
--- a/docs/epy/googleapiclient.http.MediaUpload-class.html
+++ b/docs/epy/googleapiclient.http.MediaUpload-class.html
@@ -59,16 +59,16 @@
<h1 class="epydoc">Class MediaUpload</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaUpload">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_34" name="uml_class_diagram_for_googleap_34">
-<area shape="rect" id="node1_9" href="googleapiclient.http.MediaUpload-class.html#chunksize" title="Chunk size for resumable uploads." alt="" coords="17,36,172,55"/>
-<area shape="rect" id="node1_10" href="googleapiclient.http.MediaUpload-class.html#mimetype" title="Mime type of the body." alt="" coords="17,55,172,73"/>
-<area shape="rect" id="node1_11" href="googleapiclient.http.MediaUpload-class.html#size" title="Size of upload." alt="" coords="17,73,172,92"/>
-<area shape="rect" id="node1_12" href="googleapiclient.http.MediaUpload-class.html#resumable" title="Whether this upload is resumable." alt="" coords="17,92,172,111"/>
-<area shape="rect" id="node1_13" href="googleapiclient.http.MediaUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="17,111,172,129"/>
-<area shape="rect" id="node1_14" href="googleapiclient.http.MediaUpload-class.html#has_stream" title="Does the underlying upload support a streaming interface." alt="" coords="17,129,172,148"/>
-<area shape="rect" id="node1_15" href="googleapiclient.http.MediaUpload-class.html#stream" title="A stream interface to the data being uploaded." alt="" coords="17,148,172,167"/>
-<area shape="rect" id="node1_16" href="googleapiclient.http.MediaUpload-class.html#to_json" title="Create a JSON representation of an instance of MediaUpload." alt="" coords="17,167,172,185"/>
-<area shape="rect" id="node1_17" href="googleapiclient.http.MediaUpload-class.html#new_from_json" title="Utility class method to instantiate a MediaUpload subclass from a JSON representation produced by to_json()." alt="" coords="17,185,172,204"/>
-<area shape="rect" id="node1" href="googleapiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="5,5,184,211"/>
+<area shape="rect" id="node1_9" href="googleapiclient.http.MediaUpload-class.html#chunksize" title="Chunk size for resumable uploads." alt="" coords="17,40,172,60"/>
+<area shape="rect" id="node1_10" href="googleapiclient.http.MediaUpload-class.html#mimetype" title="Mime type of the body." alt="" coords="17,60,172,80"/>
+<area shape="rect" id="node1_11" href="googleapiclient.http.MediaUpload-class.html#size" title="Size of upload." alt="" coords="17,80,172,100"/>
+<area shape="rect" id="node1_12" href="googleapiclient.http.MediaUpload-class.html#resumable" title="Whether this upload is resumable." alt="" coords="17,100,172,120"/>
+<area shape="rect" id="node1_13" href="googleapiclient.http.MediaUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="17,120,172,140"/>
+<area shape="rect" id="node1_14" href="googleapiclient.http.MediaUpload-class.html#has_stream" title="Does the underlying upload support a streaming interface." alt="" coords="17,140,172,160"/>
+<area shape="rect" id="node1_15" href="googleapiclient.http.MediaUpload-class.html#stream" title="A stream interface to the data being uploaded." alt="" coords="17,160,172,180"/>
+<area shape="rect" id="node1_16" href="googleapiclient.http.MediaUpload-class.html#to_json" title="Create a JSON representation of an instance of MediaUpload." alt="" coords="17,180,172,200"/>
+<area shape="rect" id="node1_17" href="googleapiclient.http.MediaUpload-class.html#new_from_json" title="Utility class method to instantiate a MediaUpload subclass from a JSON representation produced by to_json()." alt="" coords="17,200,172,220"/>
+<area shape="rect" id="node1" href="googleapiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="5,6,184,226"/>
</map>
<img src="uml_class_diagram_for_googleap_34.gif" alt='' usemap="#uml_class_diagram_for_googleap_34" ismap="ismap" class="graph-without-title" />
</center>
@@ -681,7 +681,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaUploadProgress-class.html b/docs/epy/googleapiclient.http.MediaUploadProgress-class.html
index 80ff89b..048c5ee 100644
--- a/docs/epy/googleapiclient.http.MediaUploadProgress-class.html
+++ b/docs/epy/googleapiclient.http.MediaUploadProgress-class.html
@@ -59,9 +59,9 @@
<h1 class="epydoc">Class MediaUploadProgress</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaUploadProgress">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_35" name="uml_class_diagram_for_googleap_35">
-<area shape="rect" id="node1_2" href="googleapiclient.http.MediaUploadProgress-class.html#__init__" title="Constructor." alt="" coords="18,36,291,55"/>
-<area shape="rect" id="node1_3" href="googleapiclient.http.MediaUploadProgress-class.html#progress" title="Percent of upload completed, as a float." alt="" coords="18,55,291,73"/>
-<area shape="rect" id="node1" href="googleapiclient.http.MediaUploadProgress-class.html" title="Status of a resumable upload." alt="" coords="5,5,303,80"/>
+<area shape="rect" id="node1_2" href="googleapiclient.http.MediaUploadProgress-class.html#__init__" title="Constructor." alt="" coords="17,39,288,59"/>
+<area shape="rect" id="node1_3" href="googleapiclient.http.MediaUploadProgress-class.html#progress" title="Percent of upload completed, as a float." alt="" coords="17,59,288,79"/>
+<area shape="rect" id="node1" href="googleapiclient.http.MediaUploadProgress-class.html" title="Status of a resumable upload." alt="" coords="5,5,299,85"/>
</map>
<img src="uml_class_diagram_for_googleap_35.gif" alt='' usemap="#uml_class_diagram_for_googleap_35" ismap="ismap" class="graph-without-title" />
</center>
@@ -273,7 +273,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.RequestMockBuilder-class.html b/docs/epy/googleapiclient.http.RequestMockBuilder-class.html
index 49df9a0..f0a4343 100644
--- a/docs/epy/googleapiclient.http.RequestMockBuilder-class.html
+++ b/docs/epy/googleapiclient.http.RequestMockBuilder-class.html
@@ -59,9 +59,9 @@
<h1 class="epydoc">Class RequestMockBuilder</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#RequestMockBuilder">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_36" name="uml_class_diagram_for_googleap_36">
-<area shape="rect" id="node1_2" href="googleapiclient.http.RequestMockBuilder-class.html#__init__" title="Constructor for RequestMockBuilder" alt="" coords="17,36,687,55"/>
-<area shape="rect" id="node1_3" href="googleapiclient.http.RequestMockBuilder-class.html#__call__" title="Implements the callable interface that discovery.build() expects of requestBuilder, which is to build an object compatible with HttpRequest.execute()." alt="" coords="17,55,687,73"/>
-<area shape="rect" id="node1" href="googleapiclient.http.RequestMockBuilder-class.html" title="A simple mock of HttpRequest" alt="" coords="5,5,699,80"/>
+<area shape="rect" id="node1_2" href="googleapiclient.http.RequestMockBuilder-class.html#__init__" title="Constructor for RequestMockBuilder" alt="" coords="17,39,680,59"/>
+<area shape="rect" id="node1_3" href="googleapiclient.http.RequestMockBuilder-class.html#__call__" title="Implements the callable interface that discovery.build() expects of requestBuilder, which is to build an object compatible with HttpRequest.execute()." alt="" coords="17,59,680,79"/>
+<area shape="rect" id="node1" href="googleapiclient.http.RequestMockBuilder-class.html" title="A simple mock of HttpRequest" alt="" coords="5,5,691,85"/>
</map>
<img src="uml_class_diagram_for_googleap_36.gif" alt='' usemap="#uml_class_diagram_for_googleap_36" ismap="ismap" class="graph-without-title" />
</center>
@@ -319,7 +319,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http._StreamSlice-class.html b/docs/epy/googleapiclient.http._StreamSlice-class.html
index 5f363cb..eea0254 100644
--- a/docs/epy/googleapiclient.http._StreamSlice-class.html
+++ b/docs/epy/googleapiclient.http._StreamSlice-class.html
@@ -59,9 +59,9 @@
<h1 class="epydoc">Class _StreamSlice</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#_StreamSlice">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_37" name="uml_class_diagram_for_googleap_37">
-<area shape="rect" id="node1_2" href="googleapiclient.http._StreamSlice-class.html#__init__" title="Constructor." alt="" coords="18,36,254,55"/>
-<area shape="rect" id="node1_3" href="googleapiclient.http._StreamSlice-class.html#read" title="Read n bytes." alt="" coords="18,55,254,73"/>
-<area shape="rect" id="node1" href="googleapiclient.http._StreamSlice-class.html" title="Truncated stream." alt="" coords="5,5,265,80"/>
+<area shape="rect" id="node1_2" href="googleapiclient.http._StreamSlice-class.html#__init__" title="Constructor." alt="" coords="17,39,253,59"/>
+<area shape="rect" id="node1_3" href="googleapiclient.http._StreamSlice-class.html#read" title="Read n bytes." alt="" coords="17,59,253,79"/>
+<area shape="rect" id="node1" href="googleapiclient.http._StreamSlice-class.html" title="Truncated stream." alt="" coords="5,5,265,85"/>
</map>
<img src="uml_class_diagram_for_googleap_37.gif" alt='' usemap="#uml_class_diagram_for_googleap_37" ismap="ismap" class="graph-without-title" />
</center>
@@ -285,7 +285,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:09 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.mimeparse-module.html b/docs/epy/googleapiclient.mimeparse-module.html
index c6eac7c..12e54ef 100644
--- a/docs/epy/googleapiclient.mimeparse-module.html
+++ b/docs/epy/googleapiclient.mimeparse-module.html
@@ -490,7 +490,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.mimeparse-pysrc.html b/docs/epy/googleapiclient.mimeparse-pysrc.html
index 07e6932..a586660 100644
--- a/docs/epy/googleapiclient.mimeparse-pysrc.html
+++ b/docs/epy/googleapiclient.mimeparse-pysrc.html
@@ -264,7 +264,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model-module.html b/docs/epy/googleapiclient.model-module.html
index d9b6d09..5813dc3 100644
--- a/docs/epy/googleapiclient.model-module.html
+++ b/docs/epy/googleapiclient.model-module.html
@@ -306,7 +306,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model-pysrc.html b/docs/epy/googleapiclient.model-pysrc.html
index 8ce1565..f6b74b9 100644
--- a/docs/epy/googleapiclient.model-pysrc.html
+++ b/docs/epy/googleapiclient.model-pysrc.html
@@ -635,7 +635,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model.BaseModel-class.html b/docs/epy/googleapiclient.model.BaseModel-class.html
index 0157996..be78d10 100644
--- a/docs/epy/googleapiclient.model.BaseModel-class.html
+++ b/docs/epy/googleapiclient.model.BaseModel-class.html
@@ -59,16 +59,16 @@
<h1 class="epydoc">Class BaseModel</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_38" name="uml_class_diagram_for_googleap_38">
-<area shape="rect" id="node1_8" href="googleapiclient.model.BaseModel-class.html#accept" title="googleapiclient.model.BaseModel.accept" alt="" coords="18,89,406,108"/>
-<area shape="rect" id="node1_9" href="googleapiclient.model.BaseModel-class.html#content_type" title="googleapiclient.model.BaseModel.content_type" alt="" coords="18,108,406,127"/>
-<area shape="rect" id="node1_10" href="googleapiclient.model.BaseModel-class.html#no_content_response" title="googleapiclient.model.BaseModel.no_content_response" alt="" coords="18,127,406,145"/>
-<area shape="rect" id="node1_11" href="googleapiclient.model.BaseModel-class.html#alt_param" title="googleapiclient.model.BaseModel.alt_param" alt="" coords="18,145,406,164"/>
-<area shape="rect" id="node1_12" href="googleapiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="18,167,406,185"/>
-<area shape="rect" id="node1_13" href="googleapiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="18,185,406,204"/>
-<area shape="rect" id="node1_14" href="googleapiclient.model.BaseModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="18,204,406,223"/>
-<area shape="rect" id="node1_15" href="googleapiclient.model.BaseModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="18,223,406,241"/>
-<area shape="rect" id="node1" href="googleapiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,67,417,248"/>
-<area shape="rect" id="node2" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="181,5,241,48"/>
+<area shape="rect" id="node1_8" href="googleapiclient.model.BaseModel-class.html#accept" title="googleapiclient.model.BaseModel.accept" alt="" coords="17,95,397,115"/>
+<area shape="rect" id="node1_9" href="googleapiclient.model.BaseModel-class.html#content_type" title="googleapiclient.model.BaseModel.content_type" alt="" coords="17,115,397,135"/>
+<area shape="rect" id="node1_10" href="googleapiclient.model.BaseModel-class.html#no_content_response" title="googleapiclient.model.BaseModel.no_content_response" alt="" coords="17,135,397,155"/>
+<area shape="rect" id="node1_11" href="googleapiclient.model.BaseModel-class.html#alt_param" title="googleapiclient.model.BaseModel.alt_param" alt="" coords="17,155,397,175"/>
+<area shape="rect" id="node1_12" href="googleapiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="17,177,397,197"/>
+<area shape="rect" id="node1_13" href="googleapiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="17,197,397,217"/>
+<area shape="rect" id="node1_14" href="googleapiclient.model.BaseModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="17,217,397,237"/>
+<area shape="rect" id="node1_15" href="googleapiclient.model.BaseModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="17,237,397,257"/>
+<area shape="rect" id="node1" href="googleapiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,69,409,264"/>
+<area shape="rect" id="node2" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="177,5,239,51"/>
</map>
<img src="uml_class_diagram_for_googleap_38.gif" alt='' usemap="#uml_class_diagram_for_googleap_38" ismap="ismap" class="graph-without-title" />
</center>
@@ -545,7 +545,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model.JsonModel-class.html b/docs/epy/googleapiclient.model.JsonModel-class.html
index 581ac37..972aaef 100644
--- a/docs/epy/googleapiclient.model.JsonModel-class.html
+++ b/docs/epy/googleapiclient.model.JsonModel-class.html
@@ -59,18 +59,18 @@
<h1 class="epydoc">Class JsonModel</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.model-pysrc.html#JsonModel">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_39" name="uml_class_diagram_for_googleap_39">
-<area shape="rect" id="node1_9" href="googleapiclient.model.JsonModel-class.html#accept" title="googleapiclient.model.JsonModel.accept" alt="" coords="107,183,318,201"/>
-<area shape="rect" id="node1_10" href="googleapiclient.model.JsonModel-class.html#content_type" title="googleapiclient.model.JsonModel.content_type" alt="" coords="107,201,318,220"/>
-<area shape="rect" id="node1_11" href="googleapiclient.model.JsonModel-class.html#alt_param" title="googleapiclient.model.JsonModel.alt_param" alt="" coords="107,220,318,239"/>
-<area shape="rect" id="node1_12" href="googleapiclient.model.JsonModel-class.html#__init__" title="Construct a JsonModel." alt="" coords="107,241,318,260"/>
-<area shape="rect" id="node1_13" href="googleapiclient.model.JsonModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="107,260,318,279"/>
-<area shape="rect" id="node1_14" href="googleapiclient.model.JsonModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="107,279,318,297"/>
-<area shape="rect" id="node1_15" href="googleapiclient.model.JsonModel-class.html#no_content_response" title="googleapiclient.model.JsonModel.no_content_response" alt="" coords="107,297,318,316"/>
-<area shape="rect" id="node1" href="googleapiclient.model.JsonModel-class.html" title="Model class for JSON." alt="" coords="95,160,330,323"/>
-<area shape="rect" id="node2_16" href="googleapiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="18,97,406,116"/>
-<area shape="rect" id="node2_17" href="googleapiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="18,116,406,135"/>
-<area shape="rect" id="node2" href="googleapiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,67,417,141"/>
-<area shape="rect" id="node3" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="181,5,241,48"/>
+<area shape="rect" id="node1_9" href="googleapiclient.model.JsonModel-class.html#accept" title="googleapiclient.model.JsonModel.accept" alt="" coords="104,195,312,215"/>
+<area shape="rect" id="node1_10" href="googleapiclient.model.JsonModel-class.html#content_type" title="googleapiclient.model.JsonModel.content_type" alt="" coords="104,215,312,235"/>
+<area shape="rect" id="node1_11" href="googleapiclient.model.JsonModel-class.html#alt_param" title="googleapiclient.model.JsonModel.alt_param" alt="" coords="104,235,312,255"/>
+<area shape="rect" id="node1_12" href="googleapiclient.model.JsonModel-class.html#__init__" title="Construct a JsonModel." alt="" coords="104,257,312,277"/>
+<area shape="rect" id="node1_13" href="googleapiclient.model.JsonModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="104,277,312,297"/>
+<area shape="rect" id="node1_14" href="googleapiclient.model.JsonModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="104,297,312,317"/>
+<area shape="rect" id="node1_15" href="googleapiclient.model.JsonModel-class.html#no_content_response" title="googleapiclient.model.JsonModel.no_content_response" alt="" coords="104,317,312,337"/>
+<area shape="rect" id="node1" href="googleapiclient.model.JsonModel-class.html" title="Model class for JSON." alt="" coords="92,169,324,343"/>
+<area shape="rect" id="node2_16" href="googleapiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="17,103,397,123"/>
+<area shape="rect" id="node2_17" href="googleapiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="17,123,397,143"/>
+<area shape="rect" id="node2" href="googleapiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,69,409,149"/>
+<area shape="rect" id="node3" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="177,5,239,51"/>
</map>
<img src="uml_class_diagram_for_googleap_39.gif" alt='' usemap="#uml_class_diagram_for_googleap_39" ismap="ismap" class="graph-without-title" />
</center>
@@ -432,7 +432,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model.MediaModel-class.html b/docs/epy/googleapiclient.model.MediaModel-class.html
index f477cea..4f8dbe4 100644
--- a/docs/epy/googleapiclient.model.MediaModel-class.html
+++ b/docs/epy/googleapiclient.model.MediaModel-class.html
@@ -59,19 +59,19 @@
<h1 class="epydoc">Class MediaModel</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.model-pysrc.html#MediaModel">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_40" name="uml_class_diagram_for_googleap_40">
-<area shape="rect" id="node1_9" href="googleapiclient.model.MediaModel-class.html#accept" title="googleapiclient.model.MediaModel.accept" alt="" coords="131,276,294,295"/>
-<area shape="rect" id="node1_10" href="googleapiclient.model.MediaModel-class.html#content_type" title="googleapiclient.model.MediaModel.content_type" alt="" coords="131,295,294,313"/>
-<area shape="rect" id="node1_11" href="googleapiclient.model.MediaModel-class.html#alt_param" title="googleapiclient.model.MediaModel.alt_param" alt="" coords="131,313,294,332"/>
-<area shape="rect" id="node1_12" href="googleapiclient.model.MediaModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="131,335,294,353"/>
-<area shape="rect" id="node1_13" href="googleapiclient.model.MediaModel-class.html#no_content_response" title="googleapiclient.model.MediaModel.no_content_response" alt="" coords="131,353,294,372"/>
-<area shape="rect" id="node1" href="googleapiclient.model.MediaModel-class.html" title="Model class for requests that return Media." alt="" coords="119,253,306,379"/>
-<area shape="rect" id="node2_14" href="googleapiclient.model.JsonModel-class.html#__init__" title="Construct a JsonModel." alt="" coords="107,191,318,209"/>
-<area shape="rect" id="node2_15" href="googleapiclient.model.JsonModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="107,209,318,228"/>
-<area shape="rect" id="node2" href="googleapiclient.model.JsonModel-class.html" title="Model class for JSON." alt="" coords="95,160,330,235"/>
-<area shape="rect" id="node3_16" href="googleapiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="18,97,406,116"/>
-<area shape="rect" id="node3_17" href="googleapiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="18,116,406,135"/>
-<area shape="rect" id="node3" href="googleapiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,67,417,141"/>
-<area shape="rect" id="node4" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="181,5,241,48"/>
+<area shape="rect" id="node1_9" href="googleapiclient.model.MediaModel-class.html#accept" title="googleapiclient.model.MediaModel.accept" alt="" coords="128,293,288,313"/>
+<area shape="rect" id="node1_10" href="googleapiclient.model.MediaModel-class.html#content_type" title="googleapiclient.model.MediaModel.content_type" alt="" coords="128,313,288,333"/>
+<area shape="rect" id="node1_11" href="googleapiclient.model.MediaModel-class.html#alt_param" title="googleapiclient.model.MediaModel.alt_param" alt="" coords="128,333,288,353"/>
+<area shape="rect" id="node1_12" href="googleapiclient.model.MediaModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="128,356,288,376"/>
+<area shape="rect" id="node1_13" href="googleapiclient.model.MediaModel-class.html#no_content_response" title="googleapiclient.model.MediaModel.no_content_response" alt="" coords="128,376,288,396"/>
+<area shape="rect" id="node1" href="googleapiclient.model.MediaModel-class.html" title="Model class for requests that return Media." alt="" coords="116,267,300,402"/>
+<area shape="rect" id="node2_14" href="googleapiclient.model.JsonModel-class.html#__init__" title="Construct a JsonModel." alt="" coords="104,201,312,221"/>
+<area shape="rect" id="node2_15" href="googleapiclient.model.JsonModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="104,221,312,241"/>
+<area shape="rect" id="node2" href="googleapiclient.model.JsonModel-class.html" title="Model class for JSON." alt="" coords="92,168,324,248"/>
+<area shape="rect" id="node3" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="177,5,239,51"/>
+<area shape="rect" id="node4_16" href="googleapiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="17,103,397,123"/>
+<area shape="rect" id="node4_17" href="googleapiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="17,123,397,143"/>
+<area shape="rect" id="node4" href="googleapiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,69,409,149"/>
</map>
<img src="uml_class_diagram_for_googleap_40.gif" alt='' usemap="#uml_class_diagram_for_googleap_40" ismap="ismap" class="graph-without-title" />
</center>
@@ -339,7 +339,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model.Model-class.html b/docs/epy/googleapiclient.model.Model-class.html
index a47d948..f42518a 100644
--- a/docs/epy/googleapiclient.model.Model-class.html
+++ b/docs/epy/googleapiclient.model.Model-class.html
@@ -59,9 +59,9 @@
<h1 class="epydoc">Class Model</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.model-pysrc.html#Model">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_41" name="uml_class_diagram_for_googleap_41">
-<area shape="rect" id="node1_2" href="googleapiclient.model.Model-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="18,36,406,55"/>
-<area shape="rect" id="node1_3" href="googleapiclient.model.Model-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="18,55,406,73"/>
-<area shape="rect" id="node1" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="5,5,417,80"/>
+<area shape="rect" id="node1_2" href="googleapiclient.model.Model-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="17,39,397,59"/>
+<area shape="rect" id="node1_3" href="googleapiclient.model.Model-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="17,59,397,79"/>
+<area shape="rect" id="node1" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="5,5,409,85"/>
</map>
<img src="uml_class_diagram_for_googleap_41.gif" alt='' usemap="#uml_class_diagram_for_googleap_41" ismap="ismap" class="graph-without-title" />
</center>
@@ -297,7 +297,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html b/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html
index f693244..db73ae4 100644
--- a/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html
+++ b/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html
@@ -59,18 +59,18 @@
<h1 class="epydoc">Class ProtocolBufferModel</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.model-pysrc.html#ProtocolBufferModel">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_42" name="uml_class_diagram_for_googleap_42">
-<area shape="rect" id="node1_9" href="googleapiclient.model.ProtocolBufferModel-class.html#accept" title="googleapiclient.model.ProtocolBufferModel.accept" alt="" coords="123,183,301,201"/>
-<area shape="rect" id="node1_10" href="googleapiclient.model.ProtocolBufferModel-class.html#content_type" title="googleapiclient.model.ProtocolBufferModel.content_type" alt="" coords="123,201,301,220"/>
-<area shape="rect" id="node1_11" href="googleapiclient.model.ProtocolBufferModel-class.html#alt_param" title="googleapiclient.model.ProtocolBufferModel.alt_param" alt="" coords="123,220,301,239"/>
-<area shape="rect" id="node1_12" href="googleapiclient.model.ProtocolBufferModel-class.html#__init__" title="Constructs a ProtocolBufferModel." alt="" coords="123,241,301,260"/>
-<area shape="rect" id="node1_13" href="googleapiclient.model.ProtocolBufferModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="123,260,301,279"/>
-<area shape="rect" id="node1_14" href="googleapiclient.model.ProtocolBufferModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="123,279,301,297"/>
-<area shape="rect" id="node1_15" href="googleapiclient.model.ProtocolBufferModel-class.html#no_content_response" title="googleapiclient.model.ProtocolBufferModel.no_content_response" alt="" coords="123,297,301,316"/>
-<area shape="rect" id="node1" href="googleapiclient.model.ProtocolBufferModel-class.html" title="Model class for protocol buffers." alt="" coords="111,160,312,323"/>
-<area shape="rect" id="node2_16" href="googleapiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="18,97,406,116"/>
-<area shape="rect" id="node2_17" href="googleapiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="18,116,406,135"/>
-<area shape="rect" id="node2" href="googleapiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,67,417,141"/>
-<area shape="rect" id="node3" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="181,5,241,48"/>
+<area shape="rect" id="node1_9" href="googleapiclient.model.ProtocolBufferModel-class.html#accept" title="googleapiclient.model.ProtocolBufferModel.accept" alt="" coords="120,195,296,215"/>
+<area shape="rect" id="node1_10" href="googleapiclient.model.ProtocolBufferModel-class.html#content_type" title="googleapiclient.model.ProtocolBufferModel.content_type" alt="" coords="120,215,296,235"/>
+<area shape="rect" id="node1_11" href="googleapiclient.model.ProtocolBufferModel-class.html#alt_param" title="googleapiclient.model.ProtocolBufferModel.alt_param" alt="" coords="120,235,296,255"/>
+<area shape="rect" id="node1_12" href="googleapiclient.model.ProtocolBufferModel-class.html#__init__" title="Constructs a ProtocolBufferModel." alt="" coords="120,257,296,277"/>
+<area shape="rect" id="node1_13" href="googleapiclient.model.ProtocolBufferModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="120,277,296,297"/>
+<area shape="rect" id="node1_14" href="googleapiclient.model.ProtocolBufferModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="120,297,296,317"/>
+<area shape="rect" id="node1_15" href="googleapiclient.model.ProtocolBufferModel-class.html#no_content_response" title="googleapiclient.model.ProtocolBufferModel.no_content_response" alt="" coords="120,317,296,337"/>
+<area shape="rect" id="node1" href="googleapiclient.model.ProtocolBufferModel-class.html" title="Model class for protocol buffers." alt="" coords="108,169,308,343"/>
+<area shape="rect" id="node2_16" href="googleapiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="17,103,397,123"/>
+<area shape="rect" id="node2_17" href="googleapiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="17,123,397,143"/>
+<area shape="rect" id="node2" href="googleapiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,69,409,149"/>
+<area shape="rect" id="node3" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="177,5,239,51"/>
</map>
<img src="uml_class_diagram_for_googleap_42.gif" alt='' usemap="#uml_class_diagram_for_googleap_42" ismap="ismap" class="graph-without-title" />
</center>
@@ -436,7 +436,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model.RawModel-class.html b/docs/epy/googleapiclient.model.RawModel-class.html
index 13edb72..f671caa 100644
--- a/docs/epy/googleapiclient.model.RawModel-class.html
+++ b/docs/epy/googleapiclient.model.RawModel-class.html
@@ -59,19 +59,19 @@
<h1 class="epydoc">Class RawModel</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.model-pysrc.html#RawModel">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_43" name="uml_class_diagram_for_googleap_43">
-<area shape="rect" id="node1_9" href="googleapiclient.model.RawModel-class.html#accept" title="googleapiclient.model.RawModel.accept" alt="" coords="131,276,294,295"/>
-<area shape="rect" id="node1_10" href="googleapiclient.model.RawModel-class.html#content_type" title="googleapiclient.model.RawModel.content_type" alt="" coords="131,295,294,313"/>
-<area shape="rect" id="node1_11" href="googleapiclient.model.RawModel-class.html#alt_param" title="googleapiclient.model.RawModel.alt_param" alt="" coords="131,313,294,332"/>
-<area shape="rect" id="node1_12" href="googleapiclient.model.RawModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="131,335,294,353"/>
-<area shape="rect" id="node1_13" href="googleapiclient.model.RawModel-class.html#no_content_response" title="googleapiclient.model.RawModel.no_content_response" alt="" coords="131,353,294,372"/>
-<area shape="rect" id="node1" href="googleapiclient.model.RawModel-class.html" title="Model class for requests that don't return JSON." alt="" coords="119,253,306,379"/>
-<area shape="rect" id="node2_14" href="googleapiclient.model.JsonModel-class.html#__init__" title="Construct a JsonModel." alt="" coords="107,191,318,209"/>
-<area shape="rect" id="node2_15" href="googleapiclient.model.JsonModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="107,209,318,228"/>
-<area shape="rect" id="node2" href="googleapiclient.model.JsonModel-class.html" title="Model class for JSON." alt="" coords="95,160,330,235"/>
-<area shape="rect" id="node3_16" href="googleapiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="18,97,406,116"/>
-<area shape="rect" id="node3_17" href="googleapiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="18,116,406,135"/>
-<area shape="rect" id="node3" href="googleapiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,67,417,141"/>
-<area shape="rect" id="node4" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="181,5,241,48"/>
+<area shape="rect" id="node1_9" href="googleapiclient.model.RawModel-class.html#accept" title="googleapiclient.model.RawModel.accept" alt="" coords="128,293,288,313"/>
+<area shape="rect" id="node1_10" href="googleapiclient.model.RawModel-class.html#content_type" title="googleapiclient.model.RawModel.content_type" alt="" coords="128,313,288,333"/>
+<area shape="rect" id="node1_11" href="googleapiclient.model.RawModel-class.html#alt_param" title="googleapiclient.model.RawModel.alt_param" alt="" coords="128,333,288,353"/>
+<area shape="rect" id="node1_12" href="googleapiclient.model.RawModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="128,356,288,376"/>
+<area shape="rect" id="node1_13" href="googleapiclient.model.RawModel-class.html#no_content_response" title="googleapiclient.model.RawModel.no_content_response" alt="" coords="128,376,288,396"/>
+<area shape="rect" id="node1" href="googleapiclient.model.RawModel-class.html" title="Model class for requests that don't return JSON." alt="" coords="116,267,300,402"/>
+<area shape="rect" id="node2_14" href="googleapiclient.model.JsonModel-class.html#__init__" title="Construct a JsonModel." alt="" coords="104,201,312,221"/>
+<area shape="rect" id="node2_15" href="googleapiclient.model.JsonModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="104,221,312,241"/>
+<area shape="rect" id="node2" href="googleapiclient.model.JsonModel-class.html" title="Model class for JSON." alt="" coords="92,168,324,248"/>
+<area shape="rect" id="node3" href="googleapiclient.model.Model-class.html" title="Model base class." alt="" coords="177,5,239,51"/>
+<area shape="rect" id="node4_16" href="googleapiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="17,103,397,123"/>
+<area shape="rect" id="node4_17" href="googleapiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="17,123,397,143"/>
+<area shape="rect" id="node4" href="googleapiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,69,409,149"/>
</map>
<img src="uml_class_diagram_for_googleap_43.gif" alt='' usemap="#uml_class_diagram_for_googleap_43" ismap="ismap" class="graph-without-title" />
</center>
@@ -339,7 +339,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.sample_tools-module.html b/docs/epy/googleapiclient.sample_tools-module.html
index df937ce..b21e1db 100644
--- a/docs/epy/googleapiclient.sample_tools-module.html
+++ b/docs/epy/googleapiclient.sample_tools-module.html
@@ -204,7 +204,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.sample_tools-pysrc.html b/docs/epy/googleapiclient.sample_tools-pysrc.html
index eee50d3..1ed5242 100644
--- a/docs/epy/googleapiclient.sample_tools-pysrc.html
+++ b/docs/epy/googleapiclient.sample_tools-pysrc.html
@@ -195,7 +195,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.schema-module.html b/docs/epy/googleapiclient.schema-module.html
index 6aae122..65dfeab 100644
--- a/docs/epy/googleapiclient.schema-module.html
+++ b/docs/epy/googleapiclient.schema-module.html
@@ -167,7 +167,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.schema-pysrc.html b/docs/epy/googleapiclient.schema-pysrc.html
index 50b70e7..b18f02c 100644
--- a/docs/epy/googleapiclient.schema-pysrc.html
+++ b/docs/epy/googleapiclient.schema-pysrc.html
@@ -459,7 +459,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.schema.Schemas-class.html b/docs/epy/googleapiclient.schema.Schemas-class.html
index 0aec113..a13287c 100644
--- a/docs/epy/googleapiclient.schema.Schemas-class.html
+++ b/docs/epy/googleapiclient.schema.Schemas-class.html
@@ -59,11 +59,11 @@
<h1 class="epydoc">Class Schemas</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_44" name="uml_class_diagram_for_googleap_44">
-<area shape="rect" id="node1_4" href="googleapiclient.schema.Schemas-class.html#__init__" title="Constructor." alt="" coords="18,36,217,55"/>
-<area shape="rect" id="node1_5" href="googleapiclient.schema.Schemas-class.html#prettyPrintByName" title="Get pretty printed object prototype from the schema name." alt="" coords="18,55,217,73"/>
-<area shape="rect" id="node1_6" href="googleapiclient.schema.Schemas-class.html#prettyPrintSchema" title="Get pretty printed object prototype of schema." alt="" coords="18,73,217,92"/>
-<area shape="rect" id="node1_7" href="googleapiclient.schema.Schemas-class.html#get" title="Get deserialized JSON schema from the schema name." alt="" coords="18,92,217,111"/>
-<area shape="rect" id="node1" href="googleapiclient.schema.Schemas-class.html" title="Schemas for an API." alt="" coords="5,5,228,117"/>
+<area shape="rect" id="node1_4" href="googleapiclient.schema.Schemas-class.html#__init__" title="Constructor." alt="" coords="17,39,216,59"/>
+<area shape="rect" id="node1_5" href="googleapiclient.schema.Schemas-class.html#prettyPrintByName" title="Get pretty printed object prototype from the schema name." alt="" coords="17,59,216,79"/>
+<area shape="rect" id="node1_6" href="googleapiclient.schema.Schemas-class.html#prettyPrintSchema" title="Get pretty printed object prototype of schema." alt="" coords="17,79,216,99"/>
+<area shape="rect" id="node1_7" href="googleapiclient.schema.Schemas-class.html#get" title="Get deserialized JSON schema from the schema name." alt="" coords="17,99,216,119"/>
+<area shape="rect" id="node1" href="googleapiclient.schema.Schemas-class.html" title="Schemas for an API." alt="" coords="5,5,227,125"/>
</map>
<img src="uml_class_diagram_for_googleap_44.gif" alt='' usemap="#uml_class_diagram_for_googleap_44" ismap="ismap" class="graph-without-title" />
</center>
@@ -485,7 +485,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.schema._SchemaToStruct-class.html b/docs/epy/googleapiclient.schema._SchemaToStruct-class.html
index 810e864..05e99f8 100644
--- a/docs/epy/googleapiclient.schema._SchemaToStruct-class.html
+++ b/docs/epy/googleapiclient.schema._SchemaToStruct-class.html
@@ -59,14 +59,14 @@
<h1 class="epydoc">Class _SchemaToStruct</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.schema-pysrc.html#_SchemaToStruct">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_googleap_45" name="uml_class_diagram_for_googleap_45">
-<area shape="rect" id="node1_7" href="googleapiclient.schema._SchemaToStruct-class.html#__init__" title="Constructor." alt="" coords="18,36,238,55"/>
-<area shape="rect" id="node1_8" href="googleapiclient.schema._SchemaToStruct-class.html#emit" title="Add text as a line to the output." alt="" coords="18,55,238,73"/>
-<area shape="rect" id="node1_9" href="googleapiclient.schema._SchemaToStruct-class.html#emitBegin" title="Add text to the output, but with no line terminator." alt="" coords="18,73,238,92"/>
-<area shape="rect" id="node1_10" href="googleapiclient.schema._SchemaToStruct-class.html#emitEnd" title="Add text and comment to the output with line terminator." alt="" coords="18,92,238,111"/>
-<area shape="rect" id="node1_11" href="googleapiclient.schema._SchemaToStruct-class.html#indent" title="Increase indentation level." alt="" coords="18,111,238,129"/>
-<area shape="rect" id="node1_12" href="googleapiclient.schema._SchemaToStruct-class.html#undent" title="Decrease indentation level." alt="" coords="18,129,238,148"/>
-<area shape="rect" id="node1_13" href="googleapiclient.schema._SchemaToStruct-class.html#to_str" title="Prototype object based on the schema, in Python code with comments." alt="" coords="18,148,238,167"/>
-<area shape="rect" id="node1" href="googleapiclient.schema._SchemaToStruct-class.html" title="Convert schema to a prototype object." alt="" coords="5,5,249,173"/>
+<area shape="rect" id="node1_7" href="googleapiclient.schema._SchemaToStruct-class.html#__init__" title="Constructor." alt="" coords="17,40,237,60"/>
+<area shape="rect" id="node1_8" href="googleapiclient.schema._SchemaToStruct-class.html#emit" title="Add text as a line to the output." alt="" coords="17,60,237,80"/>
+<area shape="rect" id="node1_9" href="googleapiclient.schema._SchemaToStruct-class.html#emitBegin" title="Add text to the output, but with no line terminator." alt="" coords="17,80,237,100"/>
+<area shape="rect" id="node1_10" href="googleapiclient.schema._SchemaToStruct-class.html#emitEnd" title="Add text and comment to the output with line terminator." alt="" coords="17,100,237,120"/>
+<area shape="rect" id="node1_11" href="googleapiclient.schema._SchemaToStruct-class.html#indent" title="Increase indentation level." alt="" coords="17,120,237,140"/>
+<area shape="rect" id="node1_12" href="googleapiclient.schema._SchemaToStruct-class.html#undent" title="Decrease indentation level." alt="" coords="17,140,237,160"/>
+<area shape="rect" id="node1_13" href="googleapiclient.schema._SchemaToStruct-class.html#to_str" title="Prototype object based on the schema, in Python code with comments." alt="" coords="17,160,237,180"/>
+<area shape="rect" id="node1" href="googleapiclient.schema._SchemaToStruct-class.html" title="Convert schema to a prototype object." alt="" coords="5,6,249,186"/>
</map>
<img src="uml_class_diagram_for_googleap_45.gif" alt='' usemap="#uml_class_diagram_for_googleap_45" ismap="ismap" class="graph-without-title" />
</center>
@@ -509,7 +509,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:10 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:07 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/help.html b/docs/epy/help.html
index 55bdd66..6c030b1 100644
--- a/docs/epy/help.html
+++ b/docs/epy/help.html
@@ -246,7 +246,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/identifier-index.html b/docs/epy/identifier-index.html
index a9d34bc..7a65463 100644
--- a/docs/epy/identifier-index.html
+++ b/docs/epy/identifier-index.html
@@ -979,7 +979,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/module-tree.html b/docs/epy/module-tree.html
index 931ea10..848e526 100644
--- a/docs/epy/module-tree.html
+++ b/docs/epy/module-tree.html
@@ -101,7 +101,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Oct 14 11:03:08 2016
+ Generated by Epydoc 3.0.1 on Fri Oct 21 13:54:05 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/uml_class_diagram_for_googleap.gif b/docs/epy/uml_class_diagram_for_googleap.gif
index f6be004..86f4563 100644
--- a/docs/epy/uml_class_diagram_for_googleap.gif
+++ b/docs/epy/uml_class_diagram_for_googleap.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_10.gif b/docs/epy/uml_class_diagram_for_googleap_10.gif
index f513ae1..b289d22 100644
--- a/docs/epy/uml_class_diagram_for_googleap_10.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_10.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_11.gif b/docs/epy/uml_class_diagram_for_googleap_11.gif
index c4c03a7..5fa8d29 100644
--- a/docs/epy/uml_class_diagram_for_googleap_11.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_11.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_12.gif b/docs/epy/uml_class_diagram_for_googleap_12.gif
index aa21ffc..3c93ccf 100644
--- a/docs/epy/uml_class_diagram_for_googleap_12.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_12.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_13.gif b/docs/epy/uml_class_diagram_for_googleap_13.gif
index 994f909..9f5ec19 100644
--- a/docs/epy/uml_class_diagram_for_googleap_13.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_13.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_14.gif b/docs/epy/uml_class_diagram_for_googleap_14.gif
index 189d9fb..4c1f0a5 100644
--- a/docs/epy/uml_class_diagram_for_googleap_14.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_14.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_15.gif b/docs/epy/uml_class_diagram_for_googleap_15.gif
index b7d84d0..9f0d471 100644
--- a/docs/epy/uml_class_diagram_for_googleap_15.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_15.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_16.gif b/docs/epy/uml_class_diagram_for_googleap_16.gif
index 4d181af..36f1612 100644
--- a/docs/epy/uml_class_diagram_for_googleap_16.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_16.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_17.gif b/docs/epy/uml_class_diagram_for_googleap_17.gif
index 7c0f0fe..1af681a 100644
--- a/docs/epy/uml_class_diagram_for_googleap_17.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_17.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_18.gif b/docs/epy/uml_class_diagram_for_googleap_18.gif
index 6530ff5..e28ee2e 100644
--- a/docs/epy/uml_class_diagram_for_googleap_18.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_18.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_19.gif b/docs/epy/uml_class_diagram_for_googleap_19.gif
index 95672f0..f5beaac 100644
--- a/docs/epy/uml_class_diagram_for_googleap_19.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_19.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_2.gif b/docs/epy/uml_class_diagram_for_googleap_2.gif
index f3328f8..040ca75 100644
--- a/docs/epy/uml_class_diagram_for_googleap_2.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_2.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_20.gif b/docs/epy/uml_class_diagram_for_googleap_20.gif
index 27a3f2f..d3b2212 100644
--- a/docs/epy/uml_class_diagram_for_googleap_20.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_20.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_21.gif b/docs/epy/uml_class_diagram_for_googleap_21.gif
index 7a7a76f..ef77139 100644
--- a/docs/epy/uml_class_diagram_for_googleap_21.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_21.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_22.gif b/docs/epy/uml_class_diagram_for_googleap_22.gif
index 78f19e5..35fa369 100644
--- a/docs/epy/uml_class_diagram_for_googleap_22.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_22.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_23.gif b/docs/epy/uml_class_diagram_for_googleap_23.gif
index 8324bf0..f48a690 100644
--- a/docs/epy/uml_class_diagram_for_googleap_23.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_23.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_24.gif b/docs/epy/uml_class_diagram_for_googleap_24.gif
index 6efdc7f..794fdf8 100644
--- a/docs/epy/uml_class_diagram_for_googleap_24.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_24.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_25.gif b/docs/epy/uml_class_diagram_for_googleap_25.gif
index fb544cb..a48db3a 100644
--- a/docs/epy/uml_class_diagram_for_googleap_25.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_25.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_26.gif b/docs/epy/uml_class_diagram_for_googleap_26.gif
index 2ce1d96..d2e72dd 100644
--- a/docs/epy/uml_class_diagram_for_googleap_26.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_26.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_27.gif b/docs/epy/uml_class_diagram_for_googleap_27.gif
index 4c471ee..9c2bffb 100644
--- a/docs/epy/uml_class_diagram_for_googleap_27.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_27.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_28.gif b/docs/epy/uml_class_diagram_for_googleap_28.gif
index 29eb3c9..ae44c0f 100644
--- a/docs/epy/uml_class_diagram_for_googleap_28.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_28.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_29.gif b/docs/epy/uml_class_diagram_for_googleap_29.gif
index 97ea4c7..cae3b90 100644
--- a/docs/epy/uml_class_diagram_for_googleap_29.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_29.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_3.gif b/docs/epy/uml_class_diagram_for_googleap_3.gif
index d77c2e6..3ab1c48 100644
--- a/docs/epy/uml_class_diagram_for_googleap_3.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_3.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_30.gif b/docs/epy/uml_class_diagram_for_googleap_30.gif
index 51360e8..f2f052c 100644
--- a/docs/epy/uml_class_diagram_for_googleap_30.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_30.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_31.gif b/docs/epy/uml_class_diagram_for_googleap_31.gif
index c7c3bb1..be08786 100644
--- a/docs/epy/uml_class_diagram_for_googleap_31.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_31.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_32.gif b/docs/epy/uml_class_diagram_for_googleap_32.gif
index a0cf5eb..1d7323b 100644
--- a/docs/epy/uml_class_diagram_for_googleap_32.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_32.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_33.gif b/docs/epy/uml_class_diagram_for_googleap_33.gif
index 661fd4d..0aec8e8 100644
--- a/docs/epy/uml_class_diagram_for_googleap_33.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_33.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_34.gif b/docs/epy/uml_class_diagram_for_googleap_34.gif
index da0446b..7f3564e 100644
--- a/docs/epy/uml_class_diagram_for_googleap_34.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_34.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_35.gif b/docs/epy/uml_class_diagram_for_googleap_35.gif
index 9a19804..c263227 100644
--- a/docs/epy/uml_class_diagram_for_googleap_35.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_35.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_36.gif b/docs/epy/uml_class_diagram_for_googleap_36.gif
index 512da76..ed62595 100644
--- a/docs/epy/uml_class_diagram_for_googleap_36.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_36.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_37.gif b/docs/epy/uml_class_diagram_for_googleap_37.gif
index dd46986..dbf307c 100644
--- a/docs/epy/uml_class_diagram_for_googleap_37.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_37.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_38.gif b/docs/epy/uml_class_diagram_for_googleap_38.gif
index dd4ab32..22b7ac0 100644
--- a/docs/epy/uml_class_diagram_for_googleap_38.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_38.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_39.gif b/docs/epy/uml_class_diagram_for_googleap_39.gif
index ac6af59..5c17b47 100644
--- a/docs/epy/uml_class_diagram_for_googleap_39.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_39.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_4.gif b/docs/epy/uml_class_diagram_for_googleap_4.gif
index cb5948e..23819fc 100644
--- a/docs/epy/uml_class_diagram_for_googleap_4.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_4.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_40.gif b/docs/epy/uml_class_diagram_for_googleap_40.gif
index d9785dc..2abee82 100644
--- a/docs/epy/uml_class_diagram_for_googleap_40.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_40.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_41.gif b/docs/epy/uml_class_diagram_for_googleap_41.gif
index 1d25a50..e8905e6 100644
--- a/docs/epy/uml_class_diagram_for_googleap_41.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_41.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_42.gif b/docs/epy/uml_class_diagram_for_googleap_42.gif
index feaeeb3..53e255e 100644
--- a/docs/epy/uml_class_diagram_for_googleap_42.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_42.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_43.gif b/docs/epy/uml_class_diagram_for_googleap_43.gif
index dedc3ab..81831dd 100644
--- a/docs/epy/uml_class_diagram_for_googleap_43.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_43.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_44.gif b/docs/epy/uml_class_diagram_for_googleap_44.gif
index d0e499a..902e0fc 100644
--- a/docs/epy/uml_class_diagram_for_googleap_44.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_44.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_45.gif b/docs/epy/uml_class_diagram_for_googleap_45.gif
index 5dd601e..b2bf6da 100644
--- a/docs/epy/uml_class_diagram_for_googleap_45.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_45.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_5.gif b/docs/epy/uml_class_diagram_for_googleap_5.gif
index a87b89b..cbc84d5 100644
--- a/docs/epy/uml_class_diagram_for_googleap_5.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_5.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_6.gif b/docs/epy/uml_class_diagram_for_googleap_6.gif
index 59a6ec3..21dc112 100644
--- a/docs/epy/uml_class_diagram_for_googleap_6.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_6.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_7.gif b/docs/epy/uml_class_diagram_for_googleap_7.gif
index 4ebc877..b4ce9dc 100644
--- a/docs/epy/uml_class_diagram_for_googleap_7.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_7.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_8.gif b/docs/epy/uml_class_diagram_for_googleap_8.gif
index 7f24432..cbd6200 100644
--- a/docs/epy/uml_class_diagram_for_googleap_8.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_8.gif
Binary files differ
diff --git a/docs/epy/uml_class_diagram_for_googleap_9.gif b/docs/epy/uml_class_diagram_for_googleap_9.gif
index 4ebc877..b4ce9dc 100644
--- a/docs/epy/uml_class_diagram_for_googleap_9.gif
+++ b/docs/epy/uml_class_diagram_for_googleap_9.gif
Binary files differ
